Skip to content

docs: add operations guides and Fumadocs documentation site - #9

Merged
filename24 merged 7 commits into
developfrom
feat/docs
Sep 9, 2026
Merged

docs: add operations guides and Fumadocs documentation site#9
filename24 merged 7 commits into
developfrom
feat/docs

Conversation

@filename24

@filename24 filename24 commented Sep 9, 2026

Copy link
Copy Markdown
Member

Summary

  • docs/: root operations guides (deployment, security, OIDC integration,
    development) as MDX sources — the single source of truth
  • apps/docs: Fumadocs static documentation site (Next.js export) that
    renders the guides plus the per-package API reference generated from each
    package's docs.api.json
  • CI: .github/workflows/docs.yml publishes the site to the gh-pages
    branch and Cloudflare Pages (inft-auth-docs project)
  • READMEs: added for apps/backend, apps/www, apps/docs and the packages;
    root README now points to the docs site
  • .gitignore: track the root docs/ and apps/docs while ignoring
    package-level api-extractor artifacts and the fumadocs content build

Verification

  • apps/docs static export builds 97 routes (guides + API reference)
    • /docs/guides/* and /docs/api/{shared,auth-core,auth-sdk}/*
  • apps/docs typecheck passes

Track the root docs/ guide and apps/docs source as the source of truth
while ignoring package-level api-extractor artifacts and the fumadocs
content build.
Deployment, security model, OIDC integration and development guides
published from apps/docs.
Next.js static-export app (apps/docs) that publishes the root guides
and per-package API references. prepare-content regenerates content/
from docs/*.mdx and packages' docs.api.json before each build.

The design mirrors the platform portal (dark navy, mint accent).
The first consumer does not belong on the public docs landing page.
Matches the api/ group so guides and reference are separated in the
sidebar tree.
@filename24
filename24 merged commit 880ec9f into develop Sep 9, 2026
@filename24
filename24 deleted the feat/docs branch September 9, 2026 14:19
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.

1 participant