📄️ Introduction
---
📄️ Document Standards
All Crew Aids must follow these structural standards. The GitLab CI/CD pipeline parses folder and file names to generate PDF filenames and validate the site build - deviations from these standards can cause build failures or incorrect PDF output.
📄️ Authoring Guidelines
The Crew Aids site runs on Docusaurus, which renders markdown as MDX - a superset of standard markdown that also parses JSX (React component syntax). This means a few things that work fine in a standard markdown previewer or VS Code will break the Docusaurus build. Read this page before writing content.
📄️ Rendering Pitfalls
Docusaurus renders markdown as MDX, which means the file is processed as a mix of markdown and JSX (React component syntax) before being rendered as HTML. This is stricter than standard markdown. The errors described on this page will either crash the page in dev mode, or - more critically - fail the CI/CD pipeline build, which rejects the commit and prevents the entire site from rendering until the error is fixed.
📄️ Git Workflow
This page covers the end-to-end workflow for authoring a new Crew Aid from a MIP and merging it into the DIP Gitlab.