Repository navigation
README links to the documentation website, social preview image - #39
Merged
Merged
Conversation
- Both READMEs link the documentation pages on https://firsttris.github.io/reactive-volcano-app/docs/ instead of the Markdown files in docs/; images stay relative so they render on GitHub - docs/social-preview.png (1280 × 640) for Settings → Social preview, rendered from scripts/social-preview/social-preview.html with npm run social-preview, documented in development.md Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Pbr82fad6qrixb8849N4wK
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
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.
What
README links point to the documentation website. Both READMEs linked the Markdown files in
docs/. They now link the pages on https://firsttris.github.io/reactive-volcano-app/docs/ (docs/usage.md→…/docs/usage.html,docs/README.md→…/docs/), anchors included. Images stay relative, so they still render on GitHub. The links also work in the Docker Hub description, where relative links were broken.Social preview image (1280 × 640).
docs/social-preview.png, rendered fromscripts/social-preview/social-preview.htmlwithnpm run social-preview: app icon, name, the supported devices, four feature chips, the "unofficial" note, and the Volcano, Venty and Crafty screenshots. Same approach as in ccu-addon-mui.docs/development.mddescribes it.GitHub does not read the image from the repository: it has to be uploaded once under Settings → General → Social preview.
Checked
mkdocs build --strictpasses; the anchors#install-as-an-app,#linuxand#updatesexist on the built pages.npm run lintpasses.🤖 Generated with Claude Code
https://claude.ai/code/session_01Pbr82fad6qrixb8849N4wK
Generated by Claude Code