Skip to content

feat(docs): versioned docs site for directory#1438

Open
keraron wants to merge 1 commit into
agntcy:mainfrom
keraron:docs-migration
Open

feat(docs): versioned docs site for directory#1438
keraron wants to merge 1 commit into
agntcy:mainfrom
keraron:docs-migration

Conversation

@keraron
Copy link
Copy Markdown
Member

@keraron keraron commented May 3, 2026

This PR introduces Directory documentation as a versioned MkDocs site with CI that builds, checks, and deploys the docs alongside the repo.

  • Adding MkDocs (Material) site under docs/ with AGNTCY theme, nav overrides, and structured content/dir/ pages
  • mike setup for versioned publishing plus GitHub Actions
  • Adding doc tooling (Taskfile, requirements, codespell / pymarkdown / lychee, include-markdown)
  • Enabling re-use through include-markdown so component docs can be referenced from the relevant repos
  • Minor root Taskfile / .gitignore updates
Screenshot 2026-05-03 at 20 50 36

@keraron keraron requested a review from a team as a code owner May 3, 2026 18:58
@github-actions github-actions Bot added the size/M Denotes a PR that changes 200-999 lines label May 3, 2026
@github-actions github-actions Bot added size/XL Denotes a PR that changes 2000+ lines and removed size/M Denotes a PR that changes 200-999 lines labels May 5, 2026
@github-actions github-actions Bot added size/M Denotes a PR that changes 200-999 lines and removed size/XL Denotes a PR that changes 2000+ lines labels May 5, 2026
@github-actions github-actions Bot added size/L Denotes a PR that changes 1000-1999 lines and removed size/M Denotes a PR that changes 200-999 lines labels May 5, 2026
Consolidate docs-migration onto current main in a single commit for
review; includes MkDocs site, reusable CI/deploy workflows, Taskfile
integration, and generated API documentation.

Signed-off-by: Aron Kerekes <arkereke@cisco.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/L Denotes a PR that changes 1000-1999 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant