Skip to content

Update docs site pages to cover newer projects #218

Description

@scouturier

Summary

The MkDocs documentation site (mkdocs.ymldocs/, published via .github/workflows/docbuild.yml) is out of date. The nav currently lists only 6 demo projects, but the repository has since grown to include several additional projects that have README.mds but no corresponding doc pages and no nav entries.

Currently documented (in mkdocs.yml nav)

  • Classification with Intercom
  • Claude Multimodal LLM Playground
  • Claude Tools Chatbot
  • Complex Schema Tool Use
  • Metaprompt Generator
  • PDF Knowledge Base with Citations

Projects in the repo missing from the docs

  • advanced-claude-code-patterns
  • agent-sdk-agentcore-memory
  • claude-agent-sdk-dynamic-skills-on-agentcore
  • claude-agent-sdk-on-agentcore
  • claude-code-on-agentcore
  • cowork-3p-in-bedrock
  • medical-idp
  • claude-platform-on-aws (no README yet)

Proposed work

  • Add a doc page under docs/projects/ for each undocumented project (source from each project's README.md).
  • Add corresponding entries to the nav in mkdocs.yml.
  • Update docs/index.md (currently just a title) with a short landing/overview of the projects.
  • Verify images referenced by new pages are picked up by copy_subproject_images.py / build_docs.sh.
  • Build the site locally (mkdocs build) to confirm no broken links or nav errors before merge.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions