Fix PMOSS docs: broken code blocks, stale repo URLs and database name

Open Beginner friendly
#1,139 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
markdown
Domain
documentation

Research direction

Start with pmoss/README.md and find the escaped fences (around lines 105-140), then check the repo links in README.md, QUICKSTART.md, CONTRIBUTING.md and FEATURES.md. Compare the D1 database name in the docs with database_name in pmoss/wrangler.toml and pick one name to use everywhere. Done when grep -r alphaonelabs-oss-project-management pmoss/ returns nothing, the README commands render as code blocks, and the D1 commands match wrangler.toml.

Written by the indexing model from the issue text.

Description

2026-11 documentation good first issue gsoc-2027 project: pmoss
Context

PMOSS moved into the monorepo but its docs still describe the old standalone repo:

  • pmoss/README.md contains 20 escaped code fences (\``bash`), so none of its setup commands render as code on GitHub (e.g. around lines 105-140).
  • Clone/issue links point to github.com/alphaonelabs/alphaonelabs-oss-project-management in README.md (69, 286), QUICKSTART.md (37), CONTRIBUTING.md (26, 84, 94, 279) and FEATURES.md (257).
  • Docs create a D1 database called oss-pm-db, but pmoss/wrangler.toml binds database_name = "pmoss".
  • Docs use your-worker.workers.dev, but the app is deployed at pmoss.alphaonelabs.com.
What to do
  • Unescape the code fences in README.md.
  • Point all clone/issue links at alphaonelabs/website (clone, then cd website/pmoss; issues filtered with the project: pmoss label).
  • Use the real database name consistently (or explain how to use your own name and update wrangler.toml).
  • Consider merging QUICKSTART.md into README.md if they duplicate each other.
Acceptance criteria
  • README.md renders its commands as code blocks on GitHub.
  • grep -r alphaonelabs-oss-project-management pmoss/ returns nothing.
  • D1 commands in the docs match wrangler.toml.
Files
  • pmoss/README.md
  • pmoss/QUICKSTART.md
  • pmoss/CONTRIBUTING.md
  • pmoss/FEATURES.md
  • pmoss/DEPLOYMENT.md
Helpful links
  • CONTRIBUTING.md (root) for the monorepo workflow

Part of GSoC 2027 onboarding — see https://gsoc.alphaonelabs.com

Dominant language
HTML
Stars
66
Forks
181
Avg merge
2m
Merged PRs (30d)
9

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from alphaonelabs/website

All issues in alphaonelabs/website

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.