Skip to content

(maint) Update docs links #415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

(maint) Update docs links #415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ JSON and Markdown output include the reference documentation only.
Strings sends JSON output to either STDOUT or to a file.
Markdown output is written to a REFERENCE.md file in the module's main directory.

See the [Puppet Strings documentation](https://puppet.com/docs/puppet/latest/puppet_strings.html) for complete instructions for generating documentation with Strings.
See the [Puppet Strings documentation](https://help.puppet.com/core/current/Content/PuppetCore/puppet_strings.htm) for complete instructions for generating documentation with Strings.

For code comment style guidelines and examples, see the [Puppet Strings style guide](https://puppet.com/docs/puppet/latest/puppet_strings_style.html).
For code comment style guidelines and examples, see the [Puppet Strings style guide](https://help.puppet.com/core/current/Content/PuppetCore/puppet_strings_style.htm).

### Additional Resources

Here are a few other good resources for getting started with documentation:

* [Module README Template](https://puppet.com/docs/puppet/latest/puppet_strings.html)
* [Module README Template](https://help.puppet.com/core/current/Content/PuppetCore/modules_readme.htm)
* [YARD Getting Started Guide](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
* [YARD Tags Overview](http://www.rubydoc.info/gems/yard/file/docs/Tags.md)

Expand Down