Skip to content

Add MkDocs documentation site with GitHub Pages deployment#2

Merged
Basigli merged 2 commits intomainfrom
copilot/document-project-using-mkdocs
Mar 20, 2026
Merged

Add MkDocs documentation site with GitHub Pages deployment#2
Basigli merged 2 commits intomainfrom
copilot/document-project-using-mkdocs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 20, 2026

Adds a full MkDocs documentation site for the FOOL Compiler, configured to deploy automatically to GitHub Pages via GitHub Actions.

Documentation structure (docs/)

  • Home – project overview, compiler phase table, quick links
  • Getting Started – prerequisites, build commands, example programs
  • Language Reference – grammar (FOOL.g4 annotated) and feature guide with code examples
  • Architecture – one page per compiler phase: AST generation, symbol table, type checking, code generation (SVM assembly, AR layout, dispatch table)

Configuration

  • mkdocs.yml – Material theme with dark/light toggle, navigation tabs, code copy, --strict build
  • .github/workflows/docs.yml – builds on push to main and deploys via actions/deploy-pages; requires Settings → Pages → Source: GitHub Actions to be enabled in the repository

Housekeeping

  • site/ added to .gitignore

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Basigli <84378604+Basigli@users.noreply.github.com>
Copilot AI changed the title [WIP] Document project using mkdocs for GitHub Pages deployment Add MkDocs documentation site with GitHub Pages deployment Mar 20, 2026
Copilot AI requested a review from Basigli March 20, 2026 14:23
@Basigli Basigli marked this pull request as ready for review March 20, 2026 14:23
@Basigli Basigli merged commit a810fd2 into main Mar 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants