Skip to content

Docs: move user-facing docs to the documentation site - #137

Merged
SandObserver merged 1 commit into
mainfrom
docs/split-user-docs-to-site
Aug 23, 2026
Merged

SandObserver merged 1 commit into
mainfrom
docs/split-user-docs-to-site

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • Delete docs/screenshots.md; keep every docs/*.png, which templates/stackyard.xml and the Docker Hub header pull from raw.githubusercontent.com.
  • Replace docs/support.md with a stub pointing at the site's Support and Troubleshooting pages, keeping the URL shipped in released images resolvable.
  • Slim README.md to a landing card: drop the table of contents, the badge and icon sections, the docker run sample and the build-from-source steps, and add a Documentation link list.
  • Retarget the Documentation and Support rows in Settings, About at the documentation site.
  • Point the generated Docker Hub header at the documentation site for docs, and at GitHub for source and issues.

Testing
All green, including the Docker build. No new tests; dockerhub-description and pwa-claims already pin the README claims this touches.

Checklist

  • Stays within the project constraints: one container, no runtime dependencies, no build step (see CONTRIBUTING.md).
  • Tests added or updated for new logic, and the full suite, lint, and typechecks pass.
  • Docs updated if behavior or configuration changed.
  • CHANGELOG.md updated under Unreleased if the change is user-visible.

@SandObserver SandObserver added the documentation Improvements or additions to documentation label Aug 22, 2026
Remove docs/screenshots.md, stub docs/support.md, and slim README.md to a
landing card that links out to the documentation site.
@SandObserver
SandObserver marked this pull request as ready for review August 23, 2026 00:36
@SandObserver
SandObserver force-pushed the docs/split-user-docs-to-site branch from 25a1da2 to 72a0f70 Compare August 23, 2026 00:36
@SandObserver
SandObserver merged commit a50d524 into main Aug 23, 2026
4 checks passed
@SandObserver
SandObserver deleted the docs/split-user-docs-to-site branch August 23, 2026 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant