How to Use These Docs
Quick guide to finding what you need without getting lost.
🗺️ What's Here
The docs are organized into eight sections:
| Section | What's Inside |
|---|---|
| Introduction | Who we are, why we're here, how these docs work |
| Tech Stack | Guides for the tools and frameworks we use |
| Best Practices | Our standards for code, architecture, and workflows |
| Projects | Documentation for specific projects we're working on |
| Guides & Tutorials | Step-by-step walkthroughs for common tasks |
| FAQ & Troubleshooting | Answers to questions we keep getting asked |
| Architecture & Patterns | Design decisions and the reasoning behind them |
| Install & Setup | How to get your dev environment running |
🎯 I Need...
Quick paths based on what you're looking for:
- "I just joined — where do I start?" → Start with What is EndToEndLabCR, then Install & Setup
- "How do I set up my environment?" → Jump to Install & Setup
- "What tech stack do we use?" → Head to Tech Stack
- "How do we structure our code?" → Check Architecture & Patterns
- "I'm stuck on something" → Try FAQ & Troubleshooting first, then ask on Discord
- "I want to contribute" → Read on — the section below is for you
💡 Tips for Getting the Most Out of These Docs
- Use the search bar — It's fast and usually finds what you need
- Bookmark sections you use often — You'll be back
- Cross-links are your friend — We link related topics so you don't have to hunt
- Check the date — If something feels outdated, it probably is. Update it or flag it
🤝 Contributing
These docs are a team effort. Here's how to pitch in:
- Spot a gap? — Write about it. A rough draft is better than no draft
- Found an error? — Fix it. Don't wait for someone else
- Have a better way? — Update the doc and explain why in your PR
- Not sure where something goes? — Put it somewhere reasonable and we'll sort it out in review
Style Quick Guide
When writing or editing:
- Be direct — Write like you're explaining to a teammate
- Show, don't tell — Use code examples, not just descriptions
- Keep it current — Outdated docs mislead. Update or archive them
- Link liberally — Connect related topics so readers can explore
📬 Feedback
Something unclear? Missing info? Have a suggestion?
- Quick fix — Edit the doc directly and submit a PR
- Bigger idea — Open an issue with your suggestion
- Want to talk it through? — Drop by Discord or ask at office hours
Ready to build? Head to Tech Stack to see what we're working with →