docs: correct setup and design documentation - #27
Merged
Merged
Conversation
The setup script creates no seed data, but the README and docs/frontend.md described seeded issues and members and built the verification steps on them. Those steps now use real sign-ins and the repository's own issues. Also: - describe the actual styling (Tailwind tokens and shadcn/ui on Base UI) instead of the removed Primer-based stylesheets - state that Compose runs migrations before the app starts - drop notes on dark mode that no longer hold, and sections that repeated each other - remove the section describing one host's private setup Signed-off-by: voidash <ashish.thapa477@gmail.com>
The README called GitHub sign-in optional and ran the app before setting it up, but the app validates its configuration at startup and refuses to start without AUTH_GITHUB_ID and AUTH_GITHUB_SECRET. Creating the OAuth App is now step 2, before running the app, and both variables are marked required. Also correct the primary navigation, the Compose services, GITHUB_PROJECT_REPOSITORY (optional, used by db:init), the language switcher, and add the welcome page to the layout listing. Signed-off-by: voidash <ashish.thapa477@gmail.com>
abhiyandhakal
previously approved these changes
Sep 27, 2026
A reviewer read the frontend guide as saying dev:session lets the app start without GitHub OAuth credentials. It does not: the app refuses to start without them, and dev:session only mints a cookie for a member who already signed in once. The guide now says both. Signed-off-by: voidash <ashish.thapa477@gmail.com>
abhiyandhakal
approved these changes
Sep 27, 2026
9 tasks done
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
2 participants
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 this changes
Corrects documentation that described things the repository does not do.
docs/frontend.mddescribed 8 seeded issues and named seeded members, and built the verification steps on them. The steps now use real sign-ins and the repository's own issues.tailwind.css, and shadcn/ui on Base UI. The old text described Primer-based stylesheets, fonts anddn-*classes that are no longer in the repository.docs/deployment.mdnow says Compose runs migrations before the app starts, ascompose.yamldoes. It no longer describes one host's private setup.Closes #25
How to check it
package.json.seed,Primer,Barlow,nisha-tamangandassets/devnepalinREADME.mdanddocs/finds nothing.Checklist
git commit -s)