Skip to content

docs: autogenerate docs#56

Merged
monoxgas merged 6 commits into
mainfrom
brian/eng-1754-docs-auto-generation
May 29, 2025
Merged

docs: autogenerate docs#56
monoxgas merged 6 commits into
mainfrom
brian/eng-1754-docs-auto-generation

Conversation

@briangreunke
Copy link
Copy Markdown
Contributor

@briangreunke briangreunke commented May 23, 2025

Docs: Autogenerate Docs

Key Changes:

  • Created a script to autogenerate Python API docs
  • Stubbed a workflow for auto docs updates
  • Workflow automatically pushed new changes

Changed:

  • docstrings for client code

@dreadnode-renovate-bot dreadnode-renovate-bot Bot added the area/github Changes made to GitHub Actions label May 23, 2025
@dreadnode-renovate-bot dreadnode-renovate-bot Bot added the area/python Changes to Python package configuration and dependencies label May 23, 2025
@briangreunke briangreunke changed the title Brian/eng 1754 docs auto generation docs: autogenerate docs May 23, 2025
@Nilzkool
Copy link
Copy Markdown

Hi @briangreunke, I noticed you’ve been keeping docs up-to-date, always good to see.

I built a small LLM-based tool for maintaining higher-level docs (SDK guides, READMEs, tutorials). It auto-updates them on PRs to prevent drift.

No pressure at all, but thought it might be useful: https://github.com/marketplace/deepdocsai

@monoxgas monoxgas merged commit 8e67381 into main May 29, 2025
9 checks passed
@monoxgas monoxgas deleted the brian/eng-1754-docs-auto-generation branch May 29, 2025 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/github Changes made to GitHub Actions area/python Changes to Python package configuration and dependencies

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants