Skip to content

Update documentation site with interactive component reference #66

@geoffjay

Description

@geoffjay

Summary

Update the MkDocs-based documentation site to link to the Storybook for live component previews, and refresh the configuration reference to accurately reflect the current XML format.

Context

The docs site (docs/public/) has configuration and getting-started guides. Static code samples in docs/public/configuration.md should:

  • Use the current XML format (not legacy HCL)
  • Link to corresponding Storybook pages so readers can see components in context
  • Be validated against the actual component schemas

Acceptance Criteria

  • docs/public/configuration.md updated with current XML format examples
  • Each component reference in the docs links to its Storybook page (e.g., /component/button)
  • Storybook hosted or documented so the links are resolvable
  • docs/public/getting-started.md updated with the nemo storybook command as a learning resource
  • docs/public/develop.md updated with LSP/VS Code extension setup instructions
  • Cross-reference added: configuration.md → architecture.md for data flow concepts
  • Any HCL references in docs replaced with XML syntax
  • MkDocs navigation updated to include the storybook and authoring tooling sections

Relevant Files

  • docs/public/configuration.md — configuration reference
  • docs/public/getting-started.md — getting started guide
  • docs/public/develop.md — developer guide
  • docs/public/architecture.md — architecture overview
  • docs/index.md — site landing page

Stack Base

  • Stack on: main
  • Blocked by: none (independent documentation updates; storybook links can be future-proofed)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions