CONTRIBUTING.md currently mentions "Add a new board" as a welcome contribution path in one short bullet. A dedicated walkthrough would meaningfully lower the barrier for first-time contributors picking up board-addition issues.
Task: write a step-by-step guide covering:
- How to inspect a board's listing page to decide
api vs html (vs browser, deferred to roadmap)
- Which
field_map keys are required vs optional, and what they map to
- Where to set
filter_hints and what to include there (rate limits, URL filter capabilities, JD URL format)
- How to test the new entry locally with
/argopia-survey
- Common pitfalls (User-Agent blocks, pagination, rate limits, CORS)
Location: either expand inline in CONTRIBUTING.md under the existing "Add a board" bullet, or create a dedicated docs/contributing/adding-a-board.md and link to it from CONTRIBUTING.md. Contributor's call — either works.
Reference material already in repo:
schemas/sources.schema.yaml — formal contract (already has description: fields per property)templates/sources.yaml — existing examples with header comments and filter_hints strings- README's "How it works" section — survey stage explanation
Acceptance: an engineer unfamiliar with Argopia's internals can follow the guide and add a working board entry in one sitting. Pairs naturally with #1 (Add The Muse) — that issue's PR can serve as the worked example.
CONTRIBUTING.mdcurrently mentions "Add a new board" as a welcome contribution path in one short bullet. A dedicated walkthrough would meaningfully lower the barrier for first-time contributors picking up board-addition issues.Task: write a step-by-step guide covering:
apivshtml(vsbrowser, deferred to roadmap)field_mapkeys are required vs optional, and what they map tofilter_hintsand what to include there (rate limits, URL filter capabilities, JD URL format)/argopia-surveyLocation: either expand inline in
CONTRIBUTING.mdunder the existing "Add a board" bullet, or create a dedicateddocs/contributing/adding-a-board.mdand link to it fromCONTRIBUTING.md. Contributor's call — either works.Reference material already in repo:
schemas/sources.schema.yaml— formal contract (already hasdescription:fields per property)templates/sources.yaml— existing examples with header comments andfilter_hintsstringsAcceptance: an engineer unfamiliar with Argopia's internals can follow the guide and add a working board entry in one sitting. Pairs naturally with #1 (Add The Muse) — that issue's PR can serve as the worked example.