docs: add MkDocs Material site with GitHub Pages CI and policy checks - #10
Merged
Conversation
Replace scattered README fragments with a structured documentation site published at https://ndevu12.github.io/Research_Assistant_Model/. Site structure (59 pages): - Getting started, user guide, architecture (incl. per-stage reference) - Configuration, retrieval providers, LLM modes, API, operations - Development guide, quality/known-issues, setup-system reference - Internal _analysis/ notes excluded from nav (maintainer reference) Tooling and CI: - mkdocs.yml with Material theme, Mermaid, search, and tabbed navigation - GitHub Actions workflow: policy check, strict build, link validation, deploy to GitHub Pages on main - scripts/check_docs_policy.py enforces no scaffolds, canonical command markers, and deduplication across nav pages - Dev deps: mkdocs, mkdocs-material, mkdocs-mermaid2-plugin, linkchecker Housekeeping: - Root contributing.md as canonical contributor entry; docs/contributing.md links to it - Slim setups/README.md and research-quality-known-issues.md to redirects - README and .env.example point to published docs - Ignore site/ and .cache/ build artifacts in .gitignore
Ndevu12
force-pushed
the
docs/mkdocs-site-github-pages-ci
branch
from
May 22, 2026 19:32
b19cc83 to
5603104
Compare
Ndevu12
added a commit
that referenced
this pull request
May 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Replace scattered README fragments with a structured documentation site published at https://ndevu12.github.io/Research_Assistant_Model/.
Site structure (59 pages):
Tooling and CI:
Housekeeping: