inclusion of an updated contribution guide and tweaks to the readme t… - #3327
inclusion of an updated contribution guide and tweaks to the readme t…#3327samironsoctopus wants to merge 3 commits into
Conversation
…o reflect new contribution guidance
|
Pull request environment is available at https://stoctodocspr3327.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
There was a problem hiding this comment.
There's an INSERT LINK HERE which would need fixing before we can approve/merge.
Regarding AI - has this been discussed? I'm not opposed to having skills and giving guidance to people to help them use claude more effectively, however the guide is written to imply that everyone should or must start with Claude. As a documentation author, I don't want to do that. Claude is useful for many things, but it does not usually create high quality documentation, and I'm hesitant about telling people that they should or must use it.
| hideInThisSectionHeader: true | ||
| --- | ||
| ``` | ||
| Page structure, frontmatter, and where version-specific notes belong are governed by the `octopus-docs-standards` skill in Claude Code — see [CONTRIBUTING.md](CONTRIBUTING.md). The guidance below covers page elements the content standards don't. |
There was a problem hiding this comment.
I'm not opposed to claude being helpful here, but I don't think it should be the only way people can access information such as our content standards. I don't have the octopus deploy claude plugins installed, for example.
…o reflect new contribution guidance