docs: Update README.md to reflect project structure and branding inte…#372
docs: Update README.md to reflect project structure and branding inte…#372Abhishekfm wants to merge 1 commit into
Conversation
|
You should probably refer to https://github.com/CivicDataLab/ids-drr-branding-types first which describes the "contract" for branding packages, and then describe the india-branding repo as an example implementation. Don't suggest reading config/branding.ts and config/site.ts for the contract. Right now, ids-drr-branding-types is only mentioned at the very end, but it's what actually controls the contract and has some docs in comments in index.ts. I recommend not using "plugin", but rather "branding package", since "plugin" is used to refer to the Django app that extends IDS-DRR-Data-Management (e.g. https://github.com/CivicDataLab/ids-drr-india-plugin). The descriptions of some env vars is not correct, e.g. BACKEND_URL must be a DataSpace deployment, and for DATA_MANAGEMENT_LAYER_URL we can link to the IDS-DRR-Data-Management repo. "getting this wrong is the most common reason a PR gets bounced" sounds like an AI hallucination. |
2 participants
Summary
Rewrites the README for contributor-friendly guide: quick start, env vars, an explanation of the branding plugin model (stub vs. real-branding, where new code belongs), the full list of npm scripts, and a project-structure tree. README-only change.
Merge timing
we will hold until the branding repo transfers are complete — the README links to those repos and the URLs may shift during transfer.
Review
Hi @jpmckinney, Could you please take a look? The main thing I want your opinion on: is this the right way to contribute? Specifically the "How the branding plugin works" section — does the stub-vs-real-branding explanation land for someone with zero prior context?