About LATTS Internal Documentation

This documentation site serves as the central knowledge repository for the LATTS team. It’s built using Hugo with the Docsy theme to provide a professional, searchable, and maintainable documentation platform.

Purpose

Our internal documentation aims to:

• Centralize Knowledge: Bring together all our guides, tools documentation, and standards in one searchable location
• Enable Collaboration: Allow team members to easily contribute and improve documentation
• Ensure Quality: Use Git workflows and pull request reviews to maintain high-quality content
• Provide Access Control: Integrate with our existing authentication systems (GitHub/Azure AD)

How It Works

Content Management

• All content is stored in Markdown files within this Git repository
• Changes are made through pull requests, ensuring proper review and approval
• The site is automatically built and deployed when changes are merged

Authentication & Access

• Access to the documentation site is controlled through SSO integration
• Supported authentication methods:
  • GitHub OAuth (recommended for developers)
  • Azure Active Directory (for broader organizational access)

Contributing

Team members can contribute by:

1. Editing existing pages using the “Edit this page” links
2. Creating new documentation files in the appropriate sections
3. Proposing structural changes through issues and discussions

Technical Details

• Static Site Generator: Hugo (Extended version)
• Theme: Google Docsy
• Hosting: GitHub Pages / Azure Static Web Apps
• Build System: GitHub Actions
• Search: Lunr.js offline search

Support

For technical issues with the documentation site itself, please:

1. Check the repository issues
2. Create a new issue if your problem isn’t already tracked
3. Contact the development team for urgent issues