Repository Management Documentation¶
This directory contains internal repository management documentation that tracks the evolution, policies, and administrative aspects of the ABS Platform repository. These documents are not intended for end users and are excluded from the public documentation site.
๐ Contents¶
Process Documentation¶
documentation-policy.md- Internal policy for organizing repository documentationdiagram-management.md- Guidelines for diagram creation and maintenancediagram-management-old.md- Previous version (kept for reference)
Status & Analysis¶
repository-status.md- Comprehensive repository development status and phaseserd-schema-analysis.md- Technical analysis of ERD vs GraphQL schema alignmentsetup-data-metadata-summary.md- Documentation of metadata convention application processarchive-notes.md- Notes about archived components and legacy systems
๐ฏ Purpose¶
These documents serve the development team and repository maintainers by:
- Tracking Evolution: Documenting how the repository structure and policies have evolved
- Maintaining Standards: Providing internal guidelines for contributors
- Recording Decisions: Keeping a record of architectural and organizational decisions
- Process Documentation: Describing internal workflows and maintenance procedures
๐ซ Exclusion from Public Documentation¶
This directory and its contents are intentionally excluded from the MkDocs-generated public documentation site. They represent internal process documentation rather than user-facing content.
MkDocs Configuration¶
The mkdocs.yml configuration should exclude this directory from navigation and builds to keep the public documentation clean and user-focused.
๐ Maintenance¶
- Update as needed: When repository policies or processes change
- Keep current: Ensure status documents reflect the actual state of the repository
- Archive old versions: When creating new versions of policy documents, keep old versions for reference
Maintained by: Repository Management Team
Visibility: Internal Only
Last Updated: January 2025