📖♻️：rewrite the README for a newcomer - #1828
Open
DerekNonGeneric wants to merge 1 commit into
Open
Conversation
👷 Deploy Preview for gh-pages-openinf processing.
|
The README explained what the portal was for but never said how to run it, so the one thing a new contributor needs first was the thing it left out. It gains a quick start, and a table of where things live. Two errors go with it. The SDK reference documentation was still called IDK, a name we have retired. And five link definitions pointed at github.com/OpenINF/open.inf.is, a repository that does not exist, so Roadmap, Issue Tracker, Changelog, Credits, and "open an issue" were all 404s. It names no version, no port, and no count. Those are the facts that go stale, and this project has been bitten by exactly that: the file now points at package.json rather than quoting it, and lets `pnpm start` print its own address. Nothing here needs revisiting when a dependency moves. The license prose became a table, and the Netlify badge became the two GitHub Actions workflows that gate and publish this repository. Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is> Assisted-by: Claude-Code:claude-opus-5
DerekNonGeneric
force-pushed
the
docs/revamp-readme
branch
from
August 17, 2026 18:38
0dc65da to
8390d9f
Compare
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.
The README described what the portal was for but never said how to run it, so
the first thing a contributor needs was the one thing it left out.
documentation
Credits, and "open an issue" all pointed at
github.com/OpenINF/open.inf.is,which is not a repository; every one of them returned a 404
It names no version, port, or count. Those are the facts that go stale, so the
file points at
package.jsonrather than quoting it, and leavespnpm startto print its own address. Nothing here needs updating when a dependency moves.
Checks
nps build && nps testpasses.nps verify.mdis clean across Prettier,markdownlint, remark with the retext readability and simplify rules, link
validation, and cspell. Every URL in the file returns 200.
livewas merged in rather than rebased, so no pushed commit was rewritten.Unrelated, and left alone
package.jsonhas"repository": "OpenINF/open.inf.is", the samenon-existent repository the dead links pointed at.
open.inf.isserves an older build thanopeninf.github.io.