Skip to content

Add automated block documentation script and workflow#12

Open
joeleenk wants to merge 3 commits into
mainfrom
add-document-blocks
Open

Add automated block documentation script and workflow#12
joeleenk wants to merge 3 commits into
mainfrom
add-document-blocks

Conversation

@joeleenk
Copy link
Copy Markdown

@joeleenk joeleenk commented May 7, 2026

This PR adds automated block documentation scripts that can be added to any project to automate AI documentation of blocks.

  • Adds an automated documentation script
  • Includes per-project json settings file
  • Includes a document-blocks.md file with setup steps
  • Includes a GH action that can run on all pushes to feature branches OR on PR creation and when a label is applied to a PR. This action will run the documentation script to update docs when changes are made to blocks
  • Updates the readme to describe the new workflow

@joeleenk joeleenk self-assigned this May 7, 2026
Copy link
Copy Markdown
Contributor

@roborourke roborourke left a comment

Choose a reason for hiding this comment

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

Think my only question is setting the branches to ignore here, would that be done in the action that calls this step instead?

@joeleenk
Copy link
Copy Markdown
Author

Yeah, we could probably add the branches to ignore as a setting in the ‎.document-blocks.json.example file. I also got some other feedback from Than in my PR where I tried it out on a client project, so I think I have a couple more things to change anyway.

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.

2 participants