**chore(archive): remove outdated documentation and summaries**
- Deleted the following obsolete files: - `CHANGES.md`, `changes-summary.md`, `CHANGES_SUMMARY.md`: Contained redundant or outdated change logs and implementation summaries. - `COMPATIBILITY.md`: Detailed compatibility behavior no longer relevant after environment detection updates. - `fix-documentation.md`: Addressed a resolved issue regarding `process.memoryUsage` errors in testing. - `DIMENSION_MISMATCH_SUMMARY.md`: Provided a legacy summary of resolved embedding dimension mismatch issues. - `demo.md`: Documented an outdated demo process for testing Brainy features. - `CONCURRENCY_IMPLEMENTATION_SUMMARY.md`: Summarized already-documented concurrency features. - `IMPLEMENTATION_SUMMARY.md`: Detailed an obsolete implementation of optional model bundling. - Purpose: - Streamline and declutter archive by removing redundant or outdated documentation. - Align repository with current feature set and documentation standards.
This commit is contained in:
parent
4e5d747a8a
commit
1539ba74de
22 changed files with 234 additions and 1122 deletions
|
|
@ -28,7 +28,7 @@ Use lowercase filenames for technical documentation and implementation details:
|
|||
- Architecture documentation
|
||||
- Specific feature documentation
|
||||
|
||||
Examples: `scalingStrategy.md`, `statistics.md`
|
||||
Examples: `SCALING_STRATEGY.md`, `STATISTICS.md`
|
||||
|
||||
## Rationale
|
||||
|
||||
|
|
@ -59,9 +59,9 @@ This convention makes it easy to distinguish between:
|
|||
|
||||
### Technical Documentation (Lowercase)
|
||||
|
||||
- scalingStrategy.md
|
||||
- SCALING_STRATEGY.md
|
||||
- statistics.md
|
||||
- architecture.md
|
||||
- implementation-details.md
|
||||
|
||||
By following these conventions, we maintain consistency and make it easier for contributors to find the right documentation.
|
||||
By following these conventions, we maintain consistency and make it easier for contributors to find the right documentation.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue