Skip to content

Launch the ask-forge docs site with API reference and guides#58

Merged
kirang89 merged 11 commits intomainfrom
feat/docs
Mar 24, 2026
Merged

Launch the ask-forge docs site with API reference and guides#58
kirang89 merged 11 commits intomainfrom
feat/docs

Conversation

@kirang89
Copy link
Contributor

@kirang89 kirang89 commented Mar 23, 2026

Summary

  • launch an Astro/Starlight docs site under docs/
  • generate API reference from the public TypeScript exports with starlight-typedoc
  • add Getting Started, Configuration, Sandbox, Observability, and Contributing guides
  • trim the README, wire the docs to GitHub Pages, and tighten the landing page layout/theme
  • include the tracing work that backs the new observability documentation
  • Addresses Make documentation for ask-forge #44

Testing

  • bun run build

Screenshots

home getting-started askforgeclient-reference

kirang89 and others added 9 commits March 23, 2026 19:49
Sets up Astro + Starlight documentation site in docs/ with
auto-generated API reference from TypeScript exports via
starlight-typedoc plugin.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Adds splash page with feature cards (Local Exploration, Sandboxed
Execution, Observability, Configurable) and guide pages for getting
started, observability, and sandbox usage.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Overrides Starlight's default color palette with a monochrome scheme
for both dark and light themes. Uses Inter from Google Fonts as the
primary sans-serif font.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Adds docs.yml workflow to build and deploy docs on push to main.
Adds just docs-build and docs-dev commands. Excludes docs/ from
biome and adds generated API docs to .gitignore.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add configuration guide covering connect options, model/provider,
system prompt, logging, sandboxing, compaction, tracing, and streaming.
Add sandbox architecture diagram generated with beautiful-mermaid.
Refine getting-started with overview/features section and sidebar ordering.
Trim redundant sections already covered by the docs site.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove detailed configuration, sandboxing, and observability sections
from README. Keep features, requirements, installation, and basic usage.
Link to the docs site for full documentation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@kirang89 kirang89 changed the title Tighten docs landing page layout Launch the ask-forge docs site with API reference and guides Mar 23, 2026
@kirang89 kirang89 self-assigned this Mar 23, 2026
@kirang89 kirang89 modified the milestone: Release 0.1 Mar 23, 2026
@kirang89 kirang89 merged commit b78e1fe into main Mar 24, 2026
2 checks passed
@kirang89 kirang89 deleted the feat/docs branch March 24, 2026 14:48
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