Add doc-edit skill - #150
Conversation
Adds the doc-edit skill (NetFoundry writing style guide checklist) so it can be shared across docs repos.
|
Documentation preview
|
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Removing this for now, as I don't think its needed context and just takes extra space
linter-fix: 19 error MD012/no-multiple-blanks Multiple consecutive blank lines [Expected 1; Actual 2]
| not just "this reads oddly." | ||
| - **Fast-scan checklist:** before signing off on any doc, confirm each of these is true. If any is unclear, jump | ||
| to the matching section below for the full rule. | ||
| - [ ] Headings use sentence-style casing. |
There was a problem hiding this comment.
aren't these already codified in a .md? https://github.com/netfoundry/docusaurus-shared/blob/main/nf-style-guide.md why not just say "use that .md" or something similar?
There was a problem hiding this comment.
This is a good point. I honestly followed the format I did as it is Anthropic's model for skill creation and the features of AI in my previous role was very siloed, they couldn't go to URLs, so that is partly out of habit. So this is a great point.
I asked Claude after you brought this up, and from my understanding it seems like if we were to link directly to the current .md for the style guide that the agent would use extra tools to get to the page and ingest the info to markdown. The link workflow would use more tokens than the current format that we have, at least from what Claude says. Let me know what you think on that. Maybe we can discuss further in person today. I have some thoughts on a best of both worlds idea, but it might be easier to talk on it rather than type it. :)
3 participants
Adds the doc-edit skill (NetFoundry writing style guide checklist) so it can be saved and shared across docs repos and team.