Skip to content

docs: revamp the README in English and Nepali - #40

Open
voidash wants to merge 1 commit into
mainfrom
docs/revamp-readme
Open

voidash wants to merge 1 commit into
mainfrom
docs/revamp-readme

Conversation

@voidash

@voidash voidash commented Sep 27, 2026 •

Copy link
Copy Markdown
Collaborator

What changed

Rewrites README.md and README.ne.md so they describe the project as it is, in both languages.

  • What the project is, its status and the Apache-2.0 licence, with a link between the two languages.
  • Run it with Docker: a Docker-only path. It covers the OAuth App, .env.local, docker compose up -d --build, and docker compose run --rm migrate node scripts/init-project.js. It points to prod-docker-compose.yaml and the Dokploy guide for production.
  • Develop locally: the Bun path, with the setup order corrected in docs: correct setup and design documentation #27.
  • Configuration, Commands, How it is built (stack, layout, API contract, members, privacy and security).
  • Contributing: points to CONTRIBUTING, docs/CONVENTIONS, the code of conduct, governance, SECURITY, the PRD and PRIVACY from docs: establish contribution and product foundations #42.

Also:

  • Removed duplication: the REST route table (now a link to openapi.yaml) and the separate Ports and test-coverage sections.
  • Fixed inaccuracies:
    • The old README said the pages are server-rendered, but the public pages load their data in the browser.
    • For a non-public profile, it is the API that returns 404; the page shows "Profile not available".
    • 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".

Closes #39

Merge after #53. The Docker commands (node scripts/..., .env support, prod-docker-compose.yaml) come from it.

Contract impact

  • No changes to packages/api-contract

Checks

  • Documentation only; CI passes.
  • Every factual claim checked against the code: env variables (config.ts, .env.example), commands (package.json), setup steps (scripts/setup.ts), rate-limited routes, GITHUB_TOKEN use, visibility and avatar behaviour, CI steps.
  • Every relative link resolves, and every table-of-contents anchor resolves under GitHub's own slug rules (github-slugger), Nepali headings included.
  • English and Nepali agree in structure: the same 7 sections, all 11 configuration rows, all 14 code blocks, and identical commands.

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

  • Commits signed off (git commit -s)
  • Works in both English and Nepali where applicable
  • No secrets or real personal data anywhere in the diff
  • Documentation updated; English and Nepali versions agree where both exist

abhiyandhakal
abhiyandhakal previously approved these changes Sep 30, 2026

@abhiyandhakal abhiyandhakal left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
voidash force-pushed the docs/revamp-readme branch from 47a6da8 to e050e75 Compare October 3, 2026 08:59
@voidash voidash changed the title docs: revamp the README docs: revamp the README in English and Nepali Oct 3, 2026
@voidash
voidash requested a review from abhiyandhakal October 3, 2026 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README is long, repetitive and partly inaccurate

2 participants