diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..056032f --- /dev/null +++ b/.gitattributes @@ -0,0 +1,23 @@ +# Auto detect text files and perform LF normalization +* text=auto + +# Explicitly declare text files you want to always be normalized and converted +# to native line endings on checkout. +*.md text +*.txt text +*.yml text +*.yaml text +*.json text +*.py text +*.css text +*.js text + +# Declare files that will always have CRLF line endings on checkout. +*.sln text eol=crlf + +# Denote all files that are truly binary and should not be modified. +*.png binary +*.jpg binary +*.gif binary +*.ico binary +*.pdf binary diff --git a/.github/INTERNAL_README.md b/.github/INTERNAL_README.md deleted file mode 100644 index 4dde741..0000000 --- a/.github/INTERNAL_README.md +++ /dev/null @@ -1,88 +0,0 @@ -# ConTextCap Internal Documentation 📚 - -> Private repository for ConTextCap's internal documentation and team resources. - -## Quick Navigation 🚀 - -| Section | Description | For | -|---------|-------------|-----| -| [📋 Maintenance Guide](maintenance/guide.md) | Daily, weekly, monthly tasks & procedures | Maintainers | -| [👥 Team Handbook](team/handbook.md) | Team processes, contacts & onboarding | All Team Members | -| [🔒 Security Policies](security/policies.md) | Security protocols & incident response | All Team Members | -| [🏗️ Project Overview](project/overview.md) | Architecture & deployment documentation | Developers | -| [🔐 Project Secrets](project/secrets.md) | Credentials & sensitive information | Admins Only | - -## Directory Structure 📂 -``` -internal-docs/ -├── maintenance/ -│ └── guide.md # Complete maintenance handbook -├── team/ -│ └── handbook.md # Team documentation & processes -├── security/ -│ └── policies.md # Security guidelines & procedures -└── project/ - ├── overview.md # Technical documentation - └── secrets.md # Sensitive information -``` - -## Common Tasks 💡 - -### For New Team Members -1. Read [Team Handbook](team/handbook.md) for onboarding -2. Review [Security Policies](security/policies.md) -3. Set up access to [Project Secrets](project/secrets.md) - -### For Maintainers -1. Follow [Maintenance Guide](maintenance/guide.md) daily -2. Monitor security using [Security Policies](security/policies.md) -3. Keep [Project Overview](project/overview.md) updated - -### For Admins -1. Manage team access to [Project Secrets](project/secrets.md) -2. Review and update [Security Policies](security/policies.md) -3. Maintain [Team Handbook](team/handbook.md) - -## Documentation Guidelines ✍️ - -1. **Updates** - - Keep documentation current - - Date all major updates - - Note significant changes in commit messages - -2. **Format** - - Use clear, concise language - - Include examples where possible - - Add tables of contents for longer documents - -3. **Security** - - Never commit sensitive data - - Use environment variables - - Follow security protocols - -## Maintenance Schedule 📅 - -| Task | Frequency | Document | -|------|-----------|----------| -| Repository Health Check | Daily | [Maintenance Guide](maintenance/guide.md) | -| Security Audit | Weekly | [Security Policies](security/policies.md) | -| Documentation Review | Monthly | All Documents | -| Team Contact Update | Quarterly | [Team Handbook](team/handbook.md) | - -## Contact Information 📞 - -- **Repository Owner**: [axw@nxtg.ai] -- **Security Team**: See [Security Policies](security/policies.md) -- **Development Lead**: See [Team Handbook](team/handbook.md) - -## Contributing 🤝 - -1. Clone this repository -2. Create a new branch for updates -3. Submit changes via Pull Request -4. Request review from appropriate team members -5. Update relevant sections in other documents if needed - ---- - -🔒 **CONFIDENTIAL**: This repository contains private information. Do not share access or contents without authorization. diff --git a/.github/TEMPLATE_README.md b/.github/TEMPLATE_README.md deleted file mode 100644 index 6ff59e9..0000000 --- a/.github/TEMPLATE_README.md +++ /dev/null @@ -1,52 +0,0 @@ -# Internal Documentation Template - -This is a template repository for maintaining internal project documentation. Use this as a starting point for creating private documentation repositories for your projects. - -## Directory Structure - -``` -internal-docs/ -├── maintenance/ -│ ├── daily-checklist.md -│ ├── weekly-tasks.md -│ ├── monthly-review.md -│ └── emergency-procedures.md -├── team/ -│ ├── onboarding.md -│ ├── processes.md -│ └── contacts.md -├── security/ -│ ├── protocols.md -│ └── incident-response.md -└── project/ - ├── architecture.md - ├── deployment.md - └── credentials.md -``` - -## How to Use This Template - -1. Create a new repository using this template -2. Name it `[project-name]-internal` -3. Set visibility to **Private** -4. Add team members in Settings > Collaborators -5. Customize documentation for your specific project - -## Template Features - -- 📋 Maintenance guides and checklists -- 🔒 Security protocols -- 👥 Team processes -- 🏗️ Project-specific documentation -- 🚨 Emergency procedures - -## Customization - -1. Update project-specific details in each document -2. Add or remove sections as needed -3. Keep credentials and sensitive information in the appropriate sections -4. Regular reviews and updates recommended - -## Contact - -For questions about this template, contact [axw@nxtg.ai] diff --git a/.github/TEMPLATE_STRUCTURE.md b/.github/TEMPLATE_STRUCTURE.md deleted file mode 100644 index dfc1902..0000000 --- a/.github/TEMPLATE_STRUCTURE.md +++ /dev/null @@ -1,55 +0,0 @@ -# Internal Documentation Structure - -## 📚 Navigation - -- [Maintenance Guides](maintenance/README.md) - - [Daily Checklist](maintenance/daily-checklist.md) - - [Weekly Tasks](maintenance/weekly-tasks.md) - - [Monthly Review](maintenance/monthly-review.md) - - [Emergency Procedures](maintenance/emergency-procedures.md) - -- [Team Documentation](team/README.md) - - [Onboarding Guide](team/onboarding.md) - - [Team Processes](team/processes.md) - - [Contact Information](team/contacts.md) - -- [Security](security/README.md) - - [Security Protocols](security/protocols.md) - - [Incident Response](security/incident-response.md) - -- [Project Documentation](project/README.md) - - [Architecture Overview](project/architecture.md) - - [Deployment Guide](project/deployment.md) - - [Credentials Management](project/credentials.md) - -## 🔄 Quick Links - -- [Daily Maintenance](maintenance/daily-checklist.md) -- [Emergency Procedures](maintenance/emergency-procedures.md) -- [Team Contacts](team/contacts.md) - -## 📋 Documentation Guidelines - -1. Each folder has its own README.md with section-specific overview -2. Use consistent markdown formatting -3. Keep sensitive information in appropriate sections -4. Update documentation with each major change -5. Review and update monthly - -## 🔍 Search Tips - -- Use GitHub's search bar with `path:` filter -- Example: `path:maintenance/ standup` to search in maintenance docs -- Use `filename:README.md` to search only overview files - -## 📝 Contributing to Docs - -1. Clone the repository -2. Create a new branch for documentation changes -3. Submit changes via Pull Request -4. Request review from team leads -5. Merge after approval - ---- - -💡 **Note**: This structure is designed to be version-controlled and template-friendly while maintaining wiki-like navigation. diff --git a/.github/structure.txt b/.github/structure.txt deleted file mode 100644 index e86556a..0000000 --- a/.github/structure.txt +++ /dev/null @@ -1,10 +0,0 @@ -internal-docs/ -├── maintenance/ -│ └── guide.md # Combines daily, weekly, monthly tasks and emergency procedures -├── team/ -│ └── handbook.md # Combines onboarding, processes, and contacts -├── security/ -│ └── policies.md # Combines protocols and incident response -└── project/ - ├── overview.md # Combines architecture and deployment info - └── secrets.md # For credentials and sensitive information \ No newline at end of file