Skip to content

Commit

Permalink
docs: update project description
Browse files Browse the repository at this point in the history
  • Loading branch information
awaliuddin committed Dec 27, 2024
1 parent a216d70 commit ffcc063
Show file tree
Hide file tree
Showing 21 changed files with 1,551 additions and 6 deletions.
87 changes: 87 additions & 0 deletions .github/GIT_WORKFLOW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Git Workflow Guide for ConTextCap 🌿

## Daily Code Push Process

### The Safe Way (AxW's Method)
```bash
# 1. Stage your changes
git add README.md .gitignore # Stage specific files
# OR
git add . # Stage all changes

# 2. Commit your changes
git commit -m "docs: update project description"
# Use prefixes like: feat, fix, docs, style, refactor, test, chore

# 3. Pull safely (won't overwrite uncommitted changes)
git pull origin main
# This is safe because your changes are already committed

# 4. Push your changes
git push origin main
```

### Important Notes
- Git WILL NOT overwrite your uncommitted local changes when pulling
- Always commit before pulling to keep your changes safe
- When in doubt, commit first!

### If Something Goes Wrong
```bash
# Undo last commit (keep changes staged)
git reset --soft HEAD^

# Undo staged changes
git reset HEAD <file>

# Discard all local changes (careful!)
git reset --hard HEAD
```

### Branch Management
```bash
# Create new branch
git checkout -b feature-name

# Switch branches
git checkout main

# Delete branch
git branch -d feature-name
```

## Commit Message Guidelines

### Format
```
type: subject
[optional body]
[optional footer]
```

### Types
- `feat`: New feature
- `fix`: Bug fix
- `docs`: Documentation changes
- `style`: Formatting, missing semi colons, etc
- `refactor`: Code restructuring
- `test`: Adding tests
- `chore`: Maintenance tasks

### Examples
```bash
git commit -m "docs: update project description and fix gitignore syntax"
git commit -m "feat: add PDF export functionality"
git commit -m "fix: resolve file path issues on Windows"
```

## Quick Reference
1. Always commit before pulling
2. Use descriptive commit messages
3. Pull before pushing
4. Create branches for major features

---

Created by AxW for ConTextCap team 🚀
19 changes: 19 additions & 0 deletions .github/INTERNAL_DOCS_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Internal Documentation

Our internal documentation is maintained in a separate private repository:
`ConTextCap-internal`

## Access Instructions

1. Request access to: https://github.com/awaliuddin/ConTextCap-internal
2. Once granted access, clone the internal docs:
```bash
git clone https://github.com/awaliuddin/ConTextCap-internal.git
```

## Documentation Structure
- `maintenance/` - Daily, weekly, and monthly maintenance guides
- `internal/` - Internal team processes and guidelines
- `security/` - Security protocols and emergency procedures

Contact [[email protected]] for access requests.
88 changes: 88 additions & 0 deletions .github/INTERNAL_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# 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**: [[email protected]]
- **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.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**
- OS: [e.g. Windows 10]
- Python Version: [e.g. 3.8.5]
- ConTextCap Version: [e.g. 1.0.0]

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
52 changes: 52 additions & 0 deletions .github/TEMPLATE_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 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 [[email protected]]
55 changes: 55 additions & 0 deletions .github/TEMPLATE_STRUCTURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# 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.
10 changes: 10 additions & 0 deletions .github/structure.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
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
Loading

0 comments on commit ffcc063

Please sign in to comment.