How wrightedu/programmers-guide-to-the-galaxy works
Project type and purpose
• Type: A documentation and onboarding guide repository.
• Purpose: Provide students and new developers with step-by-step tutorials (“Getting-Started”), advanced deep dives (“Advanced-Topics”), standard templates (capital-letter .md files), and governance rules (CONTRIBUTING.md, ARCHITECTURE.md).
File structure
• Top-level components:
– README.md: entry point, explains repo purpose.
– ARCHITECTURE.md: meta-guide to the doc structure.
– CONTRIBUTING.md: process & rules.
– Getting-Started/: beginner tutorials (Python, Git, Linux, HPC, images).
– Advanced-Topics/: deeper technical walkthroughs (AWS, GPIO, RasPi, regex, etc.).
• No code directories (no src/, lib/, frontend/, backend/), so our “components” are content modules.
• No build scripts or config files—focus is on Markdown content and directory organization.
README for additional insights
• Sections: “How do I use this guide?”, “Architecture” pointer to ARCHITECTURE.md, “Contributing,” “Issues and Projects.”
• Purpose is to funnel users through a predictable learning path.
Main components, relationships, and tech
– Entry point: README.md
– Core modules:
• “Getting-Started” (prerequisites, basics)
• “Advanced-Topics” (deeper subjects)
– Governance:
• ARCHITECTURE.md (explains structure)
• CONTRIBUTING.md (how to contribute)
– External processes:
• GitHub Issues & Projects (ticketing/workflow)
c. Architectural patterns/principles:
– Layered content (beginner → advanced)
– Single source of truth (Markdown files)
– Clear separation of concerns (Getting-Started vs. Advanced vs. contribution rules)
d. Technologies/frameworks:
– Markdown for content
– Git/GitHub for versioning, issues, and project boards
Putting it all together
• Edges with notes like “Start here,” “Prerequisites,” “How to contribute,” “Open issues/PRs.”
• How a newcomer interacts with the repository
• The hierarchy and progression of documents
• Where to find governance rules
• How contributions and issue workflows tie in