Site Development Guide
Site Development Guide 🚀
Section titled “Site Development Guide 🚀”Welcome to the development and content creation hub for the 8531 TeamSite. This section is organized to help you quickly find what you need, whether you’re writing content or writing code.
📚 Documentation Structure
Section titled “📚 Documentation Structure”Getting started with the project, environment setup, and publishing workflow.
- Setup & Development: Environment variables, installation, and running locally.
- Creating Pages: How to add new pages to the site.
- Publishing Workflow: From draft to production.
Guidelines for writing clear, consistent, and beautiful documentation.
- Page Templates: Copy-paste templates for Guides, Policies, and References.
- Typography & Style: Visual style guide and formatting best practices.
- Frontmatter Configuration: Page metadata, sidebar ordering, and role-based access.
- Video Shortcodes: Embedding videos efficiently.
Reusable UI components to enhance your pages.
- Usage Guide: General guide on importing and using components.
- Reference:
- Layouts: Understanding sidebar and layout options.
Deep dives into the technical implementation.
- System Overview: High-level architecture and project organization.
- Authentication: JWT, auth flow, and security.
- Deployment: Vercel configuration and CI/CD.
- Security: Access control and best practices.
Quick Tips
Section titled “Quick Tips”- Skim it: We’ve written these guides to be scanned. Look for bold text and code blocks.
- Copy-paste: The best way to learn is to copy an existing page and tweak it.
- Ask for help: If you get stuck, ping the core team.