Add project documentation for the developer-quickstart#10
Merged
tomncooper merged 3 commits intomainfrom Apr 9, 2026
Merged
Conversation
kornys
approved these changes
Apr 8, 2026
Introduce Hugo-compatible docs covering installation, prerequisites, architecture, accessing services, overlays, metrics, troubleshooting and uninstallation. * Add docs folder for content pages and overlays subsection * Add docs/preview.sh script for local Hugo preview and static builds * Add local preview instructions to README.md * Move repository structure section from README into docs * Update .gitignore to exclude .docs-preview/ directory Signed-off-by: Thomas Cooper <code@tomcooper.dev>
Signed-off-by: Thomas Cooper <code@tomcooper.dev>
Signed-off-by: Thomas Cooper <code@tomcooper.dev>
MikeEdgar
approved these changes
Apr 8, 2026
Frawless
approved these changes
Apr 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Introduce Hugo-compatible docs covering installation, prerequisites, architecture, accessing services, overlays, metrics, troubleshooting and uninstall.
These will be pulled into the main streamshub-site build but can also be built locally using the preview script.
Note: These have not been tested on MacOS, so if someone is able to test the instructions on Mac and advice any changes needed, I would be grateful.