Skip to content

Conversation

@bradpenney
Copy link
Contributor

@bradpenney bradpenney commented Dec 20, 2025

Summary

This PR introduces a full featured documentation site for the Firestone project, built using Zola (https://www.getzola.org/). It covers everything from installation and quick starts to advanced configuration and deep dives into the resource schema.

Key Changes

  • New Documentation Site Structure: Added a complete Zola project in docs/site/ including configuration, templates, themes, and static assets.
  • Extensive Content:
    • Getting Started: Architecture, Installation, Quickstart, and "Why Resource First" guides.
    • Core Concepts: Detailed breakdown of Resource Types, Anatomy, and a comprehensive Resource Schema reference.
    • Generation Guides: Specific guides for generating AsyncAPI, CLI, OpenAPI, and Streamlit artifacts.
    • Advanced Topics: Articles on API design principles, authentication, security, schema design, and Docker integration.
    • Examples: Walkthroughs for Addressbook, Blog API, and Simple CRUD examples.
    • Reference: CLI command reference, cheat sheets, and error message guides.
  • CI/CD: Added .github/workflows/docs.yaml to automate the documentation build process.
  • Tooling: Included helper scripts (add_frontmatter.sh, fix_anchors.py, test-docs.sh) to maintain documentation quality.
  • Dependencies: Updated pyproject.toml and poetry.lock to support documentation needs.

Motivation

To provide users and developers with a single, searchable, and comprehensive source of truth for using Firestone, replacing scattered READMEs with structured documentation.

Signed-off-by: Brad Penney penney.brad@protonmail.com

Signed-off-by: Brad Penney penney.brad@protonmail.com

Signed-off-by: Brad Penney <penney.brad@protonmail.com>
Copy link
Contributor

@dgunzy dgunzy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look good!

@bradpenney bradpenney merged commit f5d94a9 into main Dec 21, 2025
7 checks passed
@bradpenney bradpenney deleted the adding_docs_site branch December 21, 2025 11:39
cancel-in-progress: false

jobs:
test:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed, no?

- 'docs/**'
- 'firestone/**'
- '.github/workflows/docs.yaml'
pull_request:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to remove

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.

4 participants