Skip to content

Create SKILL.MD for documentation review process#8087

Merged
danielmarbach merged 11 commits intomasterfrom
docs-review
Mar 5, 2026
Merged

Create SKILL.MD for documentation review process#8087
danielmarbach merged 11 commits intomasterfrom
docs-review

Conversation

@danielmarbach
Copy link
Copy Markdown
Contributor

Add guidelines for reviewing Particular Platform documentation, including language standards, style consistency, and technical accuracy.

Add guidelines for reviewing Particular Platform documentation, including language standards, style consistency, and technical accuracy.
Added instructions for local validation of documentation changes using Particular.DocsTool.
Comment thread .github/skills/particular-docs-review/SKILL.MD
@danielmarbach
Copy link
Copy Markdown
Contributor Author

@dvdstelt I think you have also experimented with skills a lot. Anything missing?

Comment thread .github/skills/particular-docs-review/SKILL.MD Outdated
Updated installation instructions for Particular.DocsTool and added troubleshooting tips.
Also add a section about naming consistency
@danielmarbach danielmarbach marked this pull request as ready for review February 23, 2026 10:04
@danielmarbach
Copy link
Copy Markdown
Contributor Author

@dvdstelt done

@danielmarbach
Copy link
Copy Markdown
Contributor Author

I would be possible to integrate this with docs flows like this one https://github.com/githubnext/agentics/blob/main/workflows/update-docs.md

Added instructions for updating the reviewed date in documentation.
@mauroservienti
Copy link
Copy Markdown
Member

I would be possible to integrate this with docs flows like this one https://github.com/githubnext/agentics/blob/main/workflows/update-docs.md

That would be awesome

Comment thread .github/skills/particular-docs-review/SKILL.MD Outdated
Comment thread .github/skills/particular-docs-review/SKILL.MD Outdated
Comment thread .github/skills/particular-docs-review/SKILL.MD Outdated
Comment thread .github/skills/particular-docs-review/SKILL.MD Outdated
danielmarbach and others added 2 commits February 23, 2026 20:07
Co-authored-by: David Boike <david.boike@gmail.com>
Added guidelines for code sample requirements, emphasizing the use of snippet projects and proper referencing.
Comment thread .github/skills/particular-docs-review/SKILL.MD Outdated
Comment thread .github/skills/particular-docs-review/SKILL.MD
danielmarbach and others added 2 commits March 4, 2026 20:15
Co-authored-by: Steve <steve@dowling.co.nz>
Updated the SKILL.MD file to enhance clarity and consistency in documentation review guidelines, including language standards and formatting rules.
@danielmarbach
Copy link
Copy Markdown
Contributor Author

@DavidBoike I'd appreciate your approval ;)

@stevedowling stevedowling self-requested a review March 5, 2026 04:04
Comment thread .github/skills/particular-docs-review/SKILL.MD Outdated
Comment thread .github/skills/particular-docs-review/SKILL.MD
Co-authored-by: Mauro Servienti <mauro.servienti@gmail.com>
@danielmarbach
Copy link
Copy Markdown
Contributor Author

Merging. we can always improve

@danielmarbach danielmarbach merged commit c7c8836 into master Mar 5, 2026
4 checks passed
@danielmarbach danielmarbach deleted the docs-review branch March 5, 2026 07:48
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.

5 participants