Add workflow for AI documentation generation

[alecgeatches]

Use repomix to generate a markdown documentation file for AI consumption.

This PR currently uses the docs/ and examples/ folders for generation, for a total of 33,150 tokens. Here's a comparison of the options I tried:

• repomix --style=markdown docs/: 19,032 tokens
• repomix --style=markdown docs/ example/: 33,150 tokens
• repomix --style=markdown docs/ src/: 104,933 tokens
• repomix --style=markdown docs/ example/ src/: 119,051 tokens
• repomix --style=markdown docs/ example/ src/ tests/: 170,777 tokens

I've tested locally that having docs/ai.md in the docs/ folder doesn't recurse and include itself, doubling the output tokens. The output file specified by -o is ignored from the input data.

Testing

You can also experiment with this locally to test other repomix options:

# In the remote-data-blocks/ directory

npm install -g repomix
repomix --style=markdown -o docs/ai.md <folder1> <folder2> <...>

[ingeniumed]

Would it be better to run this post merge? So it seamlessly adds the necessary documentation? I could see some cases where a conflict arises but it would be a bit more efficient imo.

[alecgeatches]

Good thinking! It would require a lot of git pulls that we can avoid. Plus, the action already checks for changes prior to committing, so having it run on based on specific PR file changes is unnecessary.