docs: adds octo sts documentation #866
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Diving into this repository to fully understand its contents and purpose would be quite time-consuming. So I've leveraged Claude Code to analyse the codebase and generate comprehensive documentation - saving time while hopefully providing accurate insights for potential contributors and self-hosters. Please don't judge my laziness (or genius) too harshly 😆 !
Whilst I understand that documentation often takes a backseat when more urgent priorities arise, I rather avoid spending hours reverse-engineering the code myself (and likely making mistakes and misunderstandings), I thought having Claude create the initial documentation would be both more efficient and potentially more accurate (he says hopefully!). After all, reviewing and improving existing documentation is significantly easier than creating it from scratch.
I welcome the Octo STS maintainers to suggest as many commit suggestions to this PR as needed. My primary goal is to provide thorough documentation to get folks more aware of what it does and how. As I've mentioned elsewhere, I'm genuinely passionate about this project and want to see it widely adopted, but reducing barriers to entry is essential for that to happen - and clear documentation is the first critical step.
I shall initially mark this as a draft to gauge peoples thoughts. However, if it gets closer to being mergeable, I'm more than happy for a maintainer to mark it as ready for review.