Repository navigation
docs: a front page for the repository; authoring rules move to CONTRIBUTING.md - #13
Merged
Merged
Conversation
… CONTRIBUTING The README mixed what the site is with how its pages are written, and had no badge, no section map and no way in for someone who only wants to fix a page. - README.md: pitch, badges (deploy, docs, Discord), the sections of the site, stack, run locally, checks, contributing, security, license, credits - CONTRIBUTING.md: workflow and pre-push checks, then the old README's stack, page-writing rules, adding a module, building, API coverage, old URLs and deployment sections, unchanged - guides/contributing: the framework's authority is now CONTRIBUTING.md, docs/MANUAL.md and ui/README.md (opx_infinity #121 moves the README's manual to docs/MANUAL.md) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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.
Summary
README.mdrewritten as a front page: title, pitch, badges (deploy workflow, docs, Discord), the site's sections with links, stack, run locally, checks (check-content,types:check,check:api), deployment, contributing, security, license, credits.CONTRIBUTING.md(new, repo-specific): workflow and pre-push checks, then the old README's Stack, How the pages are written, Adding a module, Building locally, Checking API coverage, Old URLs and Deployment sections, unchanged apart from "framework README" → "framework manual (docs/MANUAL.md)".content/docs/guides/contributing.mdx: two sentences now name the framework'sCONTRIBUTING.md/docs/MANUAL.md(withui/README.md) as the authority, following README: a professional front page; the manual moves to docs/MANUAL.md, the workflow to CONTRIBUTING.md opx_infinity#121, which moves the old framework README's manual todocs/MANUAL.md. Merge after (or with) that PR.Why
The README mixed what the site is with how its pages are written; a visitor who only wanted to fix a page or find a section had no map.
Checks run
npm cinode scripts/check-content.mjs: 274 pages, 0 problemsnpm run types:checknpm run buildnpm run check:apiagainst localopx_infinity/opx_libmain: 27 failures, all pre-existing and unrelated — framework names added by opx_infinity #96–#101 that the docs have not synced yet (opx.needs.set,inventory.HEALING,chat.STAFF_PERMISSION,needs.AddNeeds/GetNeeds/SetNeedsand their exports,appearance.PriceWardrobe/PricedRoom,opx:net:inventory:giveOffer/giveAnswer/giveWithdrawn,opx:net:spawn:waiting,opx:net:calls:forget,opx:net:appearance:roomAlive,OPX.Life.Down,OPX.Schema.AddColumns,OPX.Storage.EnsureColumn). CI skips this step. A docs sync for #96–#101 is needed separately.Verified in game?
Not applicable.
🤖 Generated with Claude Code