Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

Internal Documentation

This directory contains internal project documentation that is not published to GitHub Pages.

Structure

📋 Project Planning

  • Specifications: Technical requirements and specifications
  • Architecture Decisions: Design decisions and rationale
  • Requirements: Functional and non-functional requirements

🛠️ Development

  • Setup Guide: Development environment setup
  • Contributing: Guidelines for contributors
  • Coding Standards: Code style and conventions
  • Testing Guide: Testing strategies and practices

🚀 Deployment

  • GitHub Pages Setup: Deployment configuration
  • CI/CD Pipeline: Continuous integration setup
  • Release Process: How to create and deploy releases

📝 Meeting Notes

  • Project Meetings: Meeting minutes and decisions
  • Technical Discussions: Architecture and implementation discussions

Public Documentation

For public-facing documentation (GitHub Pages), see the /docs/ directory:

  • User Guides: Step-by-step tutorials
  • API Reference: Developer documentation
  • Live Demo: Interactive application

Contributing to Documentation

Internal Docs

  • Use Markdown format
  • Follow the directory structure above
  • Include date stamps in meeting notes
  • Keep technical details and internal decisions here

Public Docs

  • Use Jekyll/Markdown format
  • Focus on user-facing content
  • Include examples and tutorials
  • Test with Jekyll locally before pushing