Basic Template

This is a template for a new MRS Electronics open source project, with an Astro/Starlight docs site in docs/.

If you don't want the docs site, just remove the docs directory and the deploy workflow at .github/workflows/docs.deploy.yaml.

New Project Checklist

Follow these steps in every new docs repository.

• Use this template to create new repo - link
• Configure new repo with correct settings - docs
• Configure GitHub Pages
  • "GitHub Actions" as source
  • Add DNS config in AWS Route 53
  • Add custom domain in GitHub
• Create a pull request
  • Update astro.config.mjs with appropriate configuration
  • Update src/content/docs/index.mdx with appropriate information
  • Update public/site.webmanifest with appropriate information
  • Update package.json with project name
  • Add any initial content
  • Replace the README.md file with information actually relevant to the project
• Merge the pull request
• Verify that deployment is successful
• Enable "Enforce HTTPS" in the GitHub pages settings (it does not seem you can do it until you have a deployment)