Skip to content

chore: remove unused JSON Schema HTML docs - #933

Merged
AlexAxthelm merged 2 commits into
mainfrom
feat/remove-schema-docs
Aug 27, 2026
Merged

chore: remove unused JSON Schema HTML docs#933
AlexAxthelm merged 2 commits into
mainfrom
feat/remove-schema-docs

Conversation

@AlexAxthelm

Copy link
Copy Markdown
Collaborator

Nobody consumes the generated schema docs in public/schema/, and maintaining them cost a Python-venv generator, a CI drift check, and stale README instructions. Remove the docs and every accessory that existed solely to produce or police them.

  • delete public/schema/ (*.v1.html + schema_doc.css/.min.js)
  • delete scripts/generate-schema-docs.sh and schema-render-config.json
  • package.json: drop schema:generate:docs; schema:generate now only runs schema:generate:types
  • CI: remove the schema-docs ("Check Schema Docs") job
  • rulesets: drop the now-orphaned "JSON Schema / Check Schema Docs" required status check from the main/production overlays
  • README: remove the stale JSON Schema documentation section
  • .prettierignore: drop stale public/schema.html
  • fix generate-types.ts docstring to reference src/schema (its actual source), not the removed public/schema/

Schema validation (schema:check) and type generation (schema:generate:types) are unaffected — they read from src/schema/.

Summary

Related issues

Closes:

Testing

Checklist

  • PR is focused on a single concern
  • Tests pass locally and in CI
  • Docs updated for user-visible changes
  • AI-assisted portions declared (see CONTRIBUTING.md)

Copilot AI lite review requested due to automatic review settings August 27, 2026 13:42
@AlexAxthelm AlexAxthelm self-assigned this Aug 27, 2026
@github-actions

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

Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://proud-glacier-0f640931e-933.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.

Pull request overview

This PR removes the generated JSON Schema HTML documentation artifact (public/schema/) and all tooling/CI/ruleset/README references that existed solely to build or enforce those docs, while keeping schema validation and TS type generation sourced from src/schema/.

Changes:

  • Deletes the generated schema documentation files under public/schema/ and the generator/config scripts under scripts/.
  • Simplifies schema:generate to only run type generation and removes the “Check Schema Docs” CI job plus its required status check from ruleset overlays.
  • Updates developer documentation and in-repo comments to remove stale schema-doc instructions and references.

Reviewed changes

Copilot reviewed 18 out of 22 changed files in this pull request and generated no comments.

Show a summary per file
File Description
scripts/schema-render-config.json Removes schema-doc renderer configuration (no longer needed).
scripts/generate-types.ts Updates docstring to reflect src/schema/ as the schema source.
scripts/generate-schema-docs.sh Removes schema HTML docs generator script.
README.md Removes stale JSON Schema documentation instructions.
public/schema/technology.v1.html Removes generated schema HTML doc artifact.
public/schema/sector.v1.html Removes generated schema HTML doc artifact.
public/schema/schema_doc.min.js Removes generated schema doc JS asset.
public/schema/schema_doc.css Removes generated schema doc CSS asset.
public/schema/metric.v1.html Removes generated schema HTML doc artifact.
public/schema/label.v1.html Removes generated schema HTML doc artifact.
public/schema/geographyItem.v1.html Removes generated schema HTML doc artifact.
public/schema/geography.v1.html Removes generated schema HTML doc artifact.
public/schema/emissionsScope.v1.html Removes generated schema HTML doc artifact.
public/schema/countryCode.v1.html Removes generated schema HTML doc artifact.
package.json Removes schema:generate:docs; schema:generate now runs only type generation.
.prettierignore Drops ignore entry for removed public/schema.html.
.github/workflows/node-json-schema.yml Removes “Check Schema Docs” job; keeps validator + generated-types check.
.github/rulesets/gitflow-production.overlay.json Removes orphaned required status check for schema docs job.
.github/rulesets/gitflow-main.overlay.json Removes orphaned required status check for schema docs job.

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

repro and others added 2 commits August 27, 2026 15:52
Nobody consumes the generated schema docs in public/schema/, and
maintaining them cost a Python-venv generator, a CI drift check, and
stale README instructions. Remove the docs and every accessory that
existed solely to produce or police them.

- delete public/schema/ (*.v1.html + schema_doc.css/.min.js)
- delete scripts/generate-schema-docs.sh and schema-render-config.json
- package.json: drop schema:generate:docs; schema:generate now only
  runs schema:generate:types
- CI: remove the schema-docs ("Check Schema Docs") job
- rulesets: drop the now-orphaned "JSON Schema / Check Schema Docs"
  required status check from the main/production overlays
- README: remove the stale JSON Schema documentation section
- .prettierignore: drop stale public/schema.html
- fix generate-types.ts docstring to reference src/schema (its actual
  source), not the removed public/schema/

Schema validation (schema:check) and type generation
(schema:generate:types) are unaffected — they read from src/schema/.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@AlexAxthelm
AlexAxthelm force-pushed the feat/remove-schema-docs branch from 169a650 to b50d591 Compare August 27, 2026 13:53
Copilot AI review requested due to automatic review settings August 27, 2026 13:53
@github-actions

Copy link
Copy Markdown

Expected version change and release notes:

1.16.1-dev.1 (v1.16.0...feat/remove-schema-docs ) (2026-08-27T13:54 UTC)

Docs

  • remove unused JSON Schema HTML docs (b372e37)

Other

  • cleanup .venv references (b50d591)

@github-actions

Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://proud-glacier-0f640931e-933.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.

Pull request overview

Copilot reviewed 18 out of 23 changed files in this pull request and generated 1 comment.

Comment thread .prettierignore
@AlexAxthelm
AlexAxthelm marked this pull request as ready for review August 27, 2026 14:16
@jacobvjk
jacobvjk self-requested a review August 27, 2026 14:17
@AlexAxthelm
AlexAxthelm merged commit cc5c583 into main Aug 27, 2026
12 of 13 checks passed
@AlexAxthelm
AlexAxthelm deleted the feat/remove-schema-docs branch August 27, 2026 14:58
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.

3 participants