Skip to content

Commit 0e411d2

Browse files
directory to .npmignore to exclude internal documentation from npm package
- Updated license URL to reference GPL-3.0 instead of MIT license
1 parent 9550e18 commit 0e411d2

File tree

3 files changed

+62
-2
lines changed

3 files changed

+62
-2
lines changed

.npmignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ PR_DESCRIPTION.md
3131
TECHNICAL_DEBT_CHECKLIST.md
3232
TEST_STABILIZATION_REPORT*.md
3333

34+
# Internal documentation (now in docs/internal/)
35+
docs/internal/
36+
3437
# Root-level test scripts
3538
test-*.js
3639
debug-*.js

docs/internal/CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -855,8 +855,8 @@ info:
855855
url: https://github.com/DevilsDev/rag-pipeline-utils
856856
email: support@devilsdev.com
857857
license:
858-
name: MIT
859-
url: https://opensource.org/licenses/MIT
858+
name: GPL-3.0
859+
url: https://opensource.org/licenses/GPL-3.0
860860

861861
paths:
862862
/dag/execute:

docs/internal/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Internal Documentation
2+
3+
This directory contains internal project documentation used during development, planning, and release processes. These files are **not published** to npm.
4+
5+
## Contents
6+
7+
### Planning & Strategy
8+
9+
- **BRANCHING_STRATEGY.md** - Git branching workflow and merge policies
10+
- **PROPOSED_CHANGES.md** - Planned features and architectural changes
11+
- **Use-Cases.md** - Internal use case analysis
12+
13+
### Development Guidelines
14+
15+
- **CLAUDE.md** - AI assistant instructions and project rules
16+
- **CONTRIBUTING.md** - Internal contribution guidelines (different from public docs)
17+
- **PLUGIN_ECOSYSTEM_GUIDE.md** - Plugin development detailed guide
18+
19+
### Release Documentation
20+
21+
- **RELEASE_ENGINEERING_REPORT.md** - Release process and automation
22+
- **RELEASE_NOTES_ESM_FIX.md** - ESM compatibility release notes
23+
- **RELEASE_NOTES_v3.md** - Version 3.0 release notes
24+
- **CHANGELOG.md** - Detailed change history
25+
26+
### Deployment & Operations
27+
28+
- **DEPLOYMENT_GUIDE.md** - Internal deployment procedures
29+
- **DEPLOYMENT_SUMMARY_v2.2.0.md** - Version 2.2.0 deployment summary
30+
31+
### Quality & Security
32+
33+
- **PRODUCTION_READINESS_CERTIFICATION.md** - Production readiness checklist
34+
- **SECURITY_VULNERABILITY_TABLE.md** - Security assessment and remediation
35+
- **LESSONS_LEARNED_AND_BEST_PRACTICES.md** - Post-mortems and learnings
36+
37+
### Project Reviews
38+
39+
- **FINAL_PRE_MERGE_REVIEW.md** - Pre-merge quality gate checklist
40+
- **PROJECT_COMPLETION_SUMMARY.md** - Project milestone summaries
41+
42+
### Temporary/Test Files
43+
44+
- **test-change.md** - Temporary test file (should be removed)
45+
46+
## For Contributors
47+
48+
These documents are maintained for internal reference and are subject to change without notice. For public-facing documentation, see:
49+
50+
- **README.md** (root) - User-facing documentation
51+
- **docs/** - Published documentation
52+
53+
## Notes
54+
55+
- These files are excluded from npm packages via `.npmignore`
56+
- Sensitive information should never be committed here
57+
- Keep documentation up-to-date with code changes

0 commit comments

Comments
 (0)