Skip to content

Conversation

@andy-stark-redis
Copy link
Contributor

@andy-stark-redis andy-stark-redis commented Nov 14, 2025

AI can benefit from some of the metadata that we already have in the doc pages. Even the simple stuff like categories is useful, but the command pages have really helpful stuff that makes the syntax of commands much easier to parse. This is just a first attempt based on what we've already got in the page sources, but once the system is in place, we might try adding some new metadata fields to the page Markdown.

All feedback welcome! There's probably a lot more we can do to refine this.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 14, 2025

DOC-5945

@github-actions
Copy link
Contributor

Staging links:
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-cat/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-deluser/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-dryrun/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-genpass/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-getuser/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-help/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-list/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-load/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-log/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-save/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-setuser/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-users/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl-whoami/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/acl/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/append/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/asking/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/auth/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.add/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.card/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.exists/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.info/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.insert/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.loadchunk/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.madd/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.mexists/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.reserve/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bf.scandump/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bgrewriteaof/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bgsave/
https://redis.io/docs/staging/DOC-5945-ai-metadata/commands/bitcount/

@andy-stark-redis andy-stark-redis requested review from a team and paoloredis November 14, 2025 16:22
@andy-stark-redis andy-stark-redis marked this pull request as ready for review November 14, 2025 16:24
Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

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

No idea what any of this does, but I'll approve anyway. 🤷🏻‍♂️

@andy-stark-redis
Copy link
Contributor Author

@dwdougherty Thanks! If you want to have a play with this, try directing Augie or ChatGPT specifically to the staging page for a command and then based on that, ask for some detail about the command (complexity or arguments, etc). You'll probably get a quick answer, or it sometimes even gives you a load of detail just from being directed to the page.

Also, if you add the index.html.md part to the end of the URL, you can see what metadata is added easily at the top of the Markdown.

@dwdougherty
Copy link
Collaborator

I just don't feel that ambitious. 🫠

@andy-stark-redis
Copy link
Contributor Author

@dwdougherty Yeah, Friday is not the time for adventure :-)

@andy-stark-redis
Copy link
Contributor Author

Thanks @paoloredis and @dwdougherty !

@andy-stark-redis andy-stark-redis merged commit 80f296e into main Nov 17, 2025
6 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-5945-ai-metadata branch November 17, 2025 14:18
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