[DOCS]: Polish docs site for public launch#48
Merged
Conversation
a8dbb1d to
5ce0628
Compare
nina-msft
approved these changes
May 19, 2026
5ce0628 to
89f62d5
Compare
nina-msft
approved these changes
May 19, 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
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.
Description
Builds on #47 to upgrade the mkdocs-material site from "functional" to "launch-ready" ahead of going public at
microsoft.github.io/RAMPART.Site identity & metadata
docs/images/RAMPART.svg.<div style>with a CSS class (.hero-logoincustom.css) for theming consistency.copyrightfooter added; Material "Made with…" attribution suppressed (extra.generator: false) - Microsoft OSS convention.extra.socialGitHub link in footer.descriptionfrontmatter on all section landing pages andindex.mdfor better SEO and richer search snippets.docs/404.md) with branded copy + search; GitHub Pages serves it automatically for missing paths.Navigation & UX
navigation.tabs+tabs.sticky).navigation.path) on every non-root page.navigation.instant,navigation.instant.progress).navigation.footer).navigation.tracking).Search
search.suggest(inline autocomplete),search.highlight(highlight matches on landed page),search.share(share-this-query button).Content authoring features
content.code.annotate) - numbered callouts in the Quickstart Step 2 adapter/session example and the Authoring Tests session example, replacing post-block bullet lists. Big pedagogical win.content.code.select+ optin forlinenums="1") on long reference implementations.pymdownx.details) -_FileInjectionreference implementation tucked into a??? noteblock to keep the surrounding tutorial scannable.pymdownx.tabbed+content.tabs.link) withLinux / macOSandWindows (PowerShell)for venv activation and ad-hoc env-var setting. Tab labels match exactly so selection syncs site-wide.pymdownx.tasklist) - release-readiness pre-flight inrelease-process.mdnow renders as checkboxes; the PR-template checklist onpull-requests.mdpicks up the styling automatically.abbr+pymdownx.snippets+content.tooltips) - site-wide definitions for RAMPART/security-specific acronyms (XPIA, PyRIT, CVE, OG, OIDC, OWASP, SemVer, PyPA, gRPC, SUT). Defined once indocs/_includes/abbreviations.md; auto-appended to every page.Build hardening
omitted_files,absolute_links,anchorsconfigured atwarn(fatal under--strict);unrecognized_linksatinfoto stage warnings without blocking until the corpus is fully cleaned.not_in_navfor404.md;exclude_docsfor_includes/and_overrides/so they don't appear in nav, search, or build output.Theme overrides
docs/_overrides/main.htmlwith an announce banner ("RAMPART is in alpha - APIs may change before 1.0") +announce.dismissfeature. The banner re-appears for everyone when we change its content, so flipping to a "1.0 stable" message after launch is one-line.theme.custom_dir: docs/_overridesenables the override.Plugins added
privacy- inlines all external assets (Roboto + Roboto Mono fonts, Material icons, Twemoji SVGs) at build time. Deployed site makes zero third-party network calls.git-revision-date-localized- adds "Last update: 2 days ago"Follow-ups (intentionally out of scope)
mkdocs-material[imaging]+ Cairo system deps) - adds rich OpenGraph preview images. Deferred to a separate PR to keep this one focused; nothing here blocks adding it later.overrides/home.htmlwith CTA buttons + a feature grid) - bigger lift; better as its own "launch polish" PR.Checklist
pre-commit run --all-filespassesuv run mkdocs serve --strictcompiles