Skip to content

Conversation

AlexDawsonUK
Copy link
Member

@AlexDawsonUK AlexDawsonUK commented May 17, 2025

It's been two weeks in the making but it's finally complete! All of the Additional Resources have been extracted from the spec and placed within their own dedicated supplement.

  • The main spec has a link to Resources at the top of the spec (as we have with all other supplements).
  • There is a cross-reference to the relevant resources next to machine testability against each Success Criteria (so it will hop to the useful links alike jumping to the technique within STAR).
  • As I was putting the links into which SC "buckets" they belonged to, I found some were lacking evidence so I researched more reinforcing material to back them (more on the way when I get the time to read).
  • The main spec also has a standards filter now based on existing links so you can identify SCs by things like relevance to SDGs and GPF (General Policy Framework), etc.
  • STAR techniques have been visually improved to match other supplements and are grouped by SC so its less like one big block.
  • Rose's global minor tweaks have been thrown in for good measure as they were non-destructive to the text.

All the updates are listed in the changelog, it's a pretty massive overhaul in terms of helping the spec to become more stable long-term and it's ended up reducing the main spec size by about 500kb (the API size increased by 100KB purely due to the structural change.

Note to users of the API (@timfrick) that the location of Resources has changed to match the fact URLs are grouped by SC rather than guideline, so developers will need to tweak code when they call the JSON file next as each SC has its own set of Resources (to make them more tailored to that SC).


Preview | Diff

@AlexDawsonUK AlexDawsonUK requested a review from timfrick May 17, 2025 06:56
@AlexDawsonUK AlexDawsonUK self-assigned this May 17, 2025
@AlexDawsonUK AlexDawsonUK added taskforce-all This issue affects every taskforce. enhancement New feature or request labels May 17, 2025
@AlexDawsonUK AlexDawsonUK added this to the Q2-2025 milestone May 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request taskforce-all This issue affects every taskforce.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants