Skip to content

docs: how to add or update pathways (README) - #986

Open
jacobvjk wants to merge 2 commits into
epic/v2from
docs/readme-adding-pathways
Open

jacobvjk wants to merge 2 commits into
epic/v2from
docs/readme-adding-pathways

Conversation

@jacobvjk

@jacobvjk jacobvjk commented Oct 7, 2026

Copy link
Copy Markdown
Collaborator

Adds an "Adding or updating pathways" section to the main README, written for the people who supply pathway content rather than only developers.

It covers:

  • The two parts of a pathway: a description (metadata) and optional benchmark data (timeseries). The description has to come first, because benchmark data may only use the regions its description lists.
  • Description steps:
    • the shared workbook pathway_data_prepared.xlsx
    • what a developer adds for a new pathway or publisher
    • the import dry run and how to read its report
    • review on the preview site
  • Benchmark data steps:
    • the preparation repository and its review workbook
    • the import dry run, which writes nothing if anything is wrong
    • a short table of the commonest errors and where to fix them
    • review on the preview site

Technical details stay in src/data/README.md, which the section links to.

Based on epic/v2, because it describes the importers that exist only there.

The workbooks are named but not linked: this repository is public and they live on RMI's SharePoint, so the README says to ask the TPR data team for access.

🤖 Generated with Claude Code

A plain-language section for the people who supply pathway content, not
only developers: the two parts of a pathway (description and benchmark
data), why the description comes first, who does what, and the steps
for each part, from the shared workbook or the preparation repository
through the import scripts' dry run to a reviewed pull request. It
includes a short table of the commonest benchmark import errors and
where to fix them.

The workbook is named, not linked: this repository is public and the
workbooks live on RMI's SharePoint.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown

Expected version change and release notes

🚨 WARNING: This PR is not expected to trigger a new version

To trigger a version bump, use at least one conventional commit message in this branch. See: https://www.conventionalcommits.org/en/v1.0.0/

@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://proud-glacier-0f640931e-986.westus2.2.azurestaticapps.net

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Several workflow instructions conflict with importer behavior and could lead to skipped pathways or incorrect metadata.

3 open findings
What changed in this PR

Adds contributor-focused guidance for importing pathway descriptions and benchmark data.

Changes:

  • Documents workbook and importer workflows.
  • Explains validation, preview, and publishing steps.
  • Links detailed data-format documentation.
File Description
README.md Adds pathway authoring and import guidance.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
- The metadata importer only handles pathways on its TARGETS list;
  others are reported as unmatched and skipped. A new pathway copies
  its publisher, licence and links from a template file, so the README
  says to pick a template from the same publisher, and that a new
  publisher's publication details are written by hand after import.
- The preparation repository writes one file per dataset, and a
  dataset can belong to several pathways.
- An undeclared-geography or unknown-pathway error does not by itself
  mean the description is missing something: the data may be the one
  that is wrong. The table now says to check the publication and fix
  whichever side is wrong.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown

Expected version change and release notes

🚨 WARNING: This PR is not expected to trigger a new version

To trigger a version bump, use at least one conventional commit message in this branch. See: https://www.conventionalcommits.org/en/v1.0.0/

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://proud-glacier-0f640931e-986.westus2.2.azurestaticapps.net

@jacobvjk
jacobvjk requested a review from AlexAxthelm October 8, 2026 08:07
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.

2 participants