puppetlabs / puppetlabs/puppet-editor-services
Generate documentation using Puppet Strings
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 52
- Forks
- 21
- Avg merge
- 15h
- Merged PRs (30d)
- 3
Description
Generate documentation using Puppet Strings
-
A standalone command (e.g.
Puppet : Generate Module Documentation) -
Possibly a standalone command to generate documentation for the currently edited file (e.g.
Puppet : Preview documentation for this file), which would create a virtual, Read Only markdown document. Similar to the current Preview Markdown command. -
An optional client side event watcher for File -> Save. And then depending on the file, automatically generate the module documentation. This would be behind a setting as you probable wouldn't want this on by default.
Also it should only be active if you're in a module.
Originally posted by @glennsarti in https://github.com/puppetlabs/puppet-vscode/issues/153#issuecomment-549338625
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing Preview Markdown command and the editor's File → Save event handling, then trace how the extension determines whether a file is in a module. Done means a standalone Puppet Strings documentation command, an optional read-only preview for the current file, and an opt-in save watcher that only runs inside modules.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100