docs: standardise README and add docs/ - #999
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
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.
Brings willtheorangeguy.github.io in line with the Wave 2 documentation contract.
Read this first:
src/pages/projects.astrohardcodes image URLs into other repositories'docs/images/directories, which this sweep is deleting in favour ofwilltheorangeguy/.github/icons/. One of those images is already broken and twelve more break as the other open PRs merge. Every replacement already exists centrally. Details and the full list are indocs/internal/known-issues.md; nothing insrc/is changed here.README — rewritten to the house template. The logo used a
github.com/.../blob/URL, which serves an HTML page rather than image bytes, so the repository's front page opened with a broken image; both images now come from.github/icons/. The Discord badge and link are dropped, and## Changelogand## You may also like...are removed.docs/ —
README.md(index),quickstart.md,installation.md,usage.md(renamed fromUSAGE.mdand rewritten around writing posts rather than only running the site),configuration.md,architecture.md,development.md,deployment.md,faq.md,troubleshooting.md,roadmap.md, andinternal/known-issues.md.google-maps-automation.mdis kept as it was.docs/images/is removed — both files already exist in.github/icons/willtheorangeguy.github.io/.docs/google-maps-stats.mdwas a tracked empty file, written by nothing and linked from nowhere. Deleted.docs/legal/PRIVACY.mdandTERMS.mdare renamed to lowercase, and their Contact Us links given a scheme — both read](github.com/...), which Markdown resolves as a relative path, so the one link a reader follows to make a data request was a 404.Findings — eight, recorded in
docs/internal/known-issues.md:docs/images/(High), with the per-repository status listed.docker run -p 8000:80maps a port nothing listens on (Medium) —nginx/nginx.confhaslisten 8080.blob/URL (Medium). Corrected.npm install.docs/google-maps-stats.mdwas a tracked empty file (Low). Deleted.CLAUDE.mddescribes a build pipeline missing the Storybook step and calls the site Astro 6 wherepackage.jsonpins Astro 7 (Low).PLANNING.mdis a three-line stub pointing at retired classic Projects (Low).