Conversation
abhiyandhakal
previously approved these changes
Sep 30, 2026
abhiyandhakal
left a comment
Collaborator
There was a problem hiding this comment.
LGTM.
But merge conflicts need to be resolved before merge.
Rewrite the README around what a new reader needs: what the project is, a Docker-only path tested from a fresh clone, local development, configuration, commands, how it is built, and how to contribute through CONTRIBUTING and docs/CONVENTIONS. Link the OpenAPI contract and .env.example instead of repeating them, and state the Apache-2.0 licence. Fix claims that were wrong: the public pages load their data in the browser rather than being server-rendered, a non-public profile returns 404 from the API while the page shows 'Profile not available', and the branch workflow described the personal repository's rules. README.ne.md said the project was still in documentation and planning, with no runnable application. It now carries the same content as the English README, as the conventions require. Signed-off-by: voidash <ashish.thapa477@gmail.com>
voidash
force-pushed
the
docs/revamp-readme
branch
from
October 3, 2026 08:59
47a6da8 to
e050e75
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
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 changed
Rewrites
README.mdandREADME.ne.mdso they describe the project as it is, in both languages..env.local,docker compose up -d --build, anddocker compose run --rm migrate node scripts/init-project.js. It points toprod-docker-compose.yamland the Dokploy guide for production.Also:
openapi.yaml) and the separate Ports and test-coverage sections.README.ne.mdsaid the project was still in "documentation and planning" with "no runnable application".Closes #39
Merge after #53. The Docker commands (
node scripts/...,.envsupport,prod-docker-compose.yaml) come from it.Contract impact
packages/api-contractChecks
config.ts,.env.example), commands (package.json), setup steps (scripts/setup.ts), rate-limited routes,GITHUB_TOKENuse, visibility and avatar behaviour, CI steps.github-slugger), Nepali headings included.Notes for reviewers
The Nepali text needs a native-speaker review, as the PRD requires for every Nepali string. Commands, file paths and setting names stay in English in both versions.
Foundation checklist
git commit -s)