OvertureMaps / OvertureMaps/schema

[BUG](ci) Schema PR preview generates docs to the pre-#512 path, leaving the schema sidebar empty

Open Beginner friendly
#755 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
213
Forks
22
Avg merge
3d 3h
Merged PRs (30d)
31

Description

Type

Bug

Scope

Multi-theme or Platform

Skillset

dev ops

Description

What

.github/workflows/schema-pr-preview.yml (line 62) generates the schema markdown into the docs repo at docs/schema/reference:

- name: Generate schema markdown docs
  uses: OvertureMaps/workflows/.github/actions/generate-schema-docs@main
  with:
    output-dir: ${{ github.workspace }}/${{ env.DOCS_PATH }}/docs/schema/reference

OvertureMaps/docs#512 ("Version the schema reference docs per released schema tag", merged 2026-09-17 17:08 UTC) moved the schema reference into its own Docusaurus docs instance rooted at schema/, not docs/schema/. In the docs repo today:

  • docusaurus.config.js (lines 128-130): plugin id schema, path: 'schema', routeBasePath: 'schema'
  • docs/schema/index.md was moved to schema/index.md by that PR
  • .gitignore was updated in the same PR from docs/schema/reference/ to schema/reference/

The workflow still points at the old location, so in SCHEMA_PREVIEW=true builds the schema instance finds no reference docs and sidebars-schema.js has nothing to autogenerate from.

Impact

The build does not fail, which is why this has not surfaced yet. It goes green and publishes a degraded preview.

Reproduced locally against docs@fccbbe22 by copying a generated reference tree to docs/schema/reference and running SCHEMA_PREVIEW=true npm run build:

[WARNING] No docs found in "reference": can't auto-generate a sidebar.
[SUCCESS] Generated static files in "build".

In the resulting site:

  • /schema/ renders the overview page with an empty sidebar — zero links to any reference page
  • 139 reference pages are still emitted at /schema/reference/*, but by the main docs instance (routeBasePath: '/'), so they carry the main docs sidebar and chrome and no schema version dropdown

Building the same tree with the reference docs at schema/reference instead produces the pages under the schema instance with its own populated sidebar.

No preview run has exercised the new layout yet: the most recent schema-pr-preview.yml run finished 2026-09-17 14:14 UTC, roughly three hours before OvertureMaps/docs#512 merged. The next schema PR will be the first to hit this.

Fix

output-dir: ${{ github.workspace }}/${{ env.DOCS_PATH }}/schema/reference

Acceptance criteria

  • A schema PR preview shows the reference pages under /schema/ with the autogenerated sidebar populated
  • The No docs found in "reference" warning no longer appears in the preview build log
  • Nothing is generated under _docs/docs/ — note the docs repo's .gitignore entry schema/reference/ is root-anchored and does not cover docs/schema/reference/, so output at the old path is not ignored

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Update .github/workflows/schema-pr-preview.yml at the schema documentation generation step, using the docs repository layout described in the issue. Run the SCHEMA_PREVIEW=true docs build and verify that the schema reference sidebar is populated, the warning about no docs in "reference" is absent, and no files are generated under _docs/docs/.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.