Skip to content

docs: sync API errors catalogue (nvm-monorepo@5e8d407) - #248

Closed
eruizgar91 wants to merge 1 commit into
mainfrom
sync/api-errors-5e8d407
Closed

docs: sync API errors catalogue (nvm-monorepo@5e8d407)#248
eruizgar91 wants to merge 1 commit into
mainfrom
sync/api-errors-5e8d407

Conversation

@eruizgar91

Copy link
Copy Markdown
Member

Auto-generated by the sync-errors-docs.yml workflow in nvm-monorepo from 5e8d407830c65e15c4f2cfb39a4dfc15da9ce43e.

Source-of-truth: libs/helpers/src/lib/output/api-errors.ts in nvm-monorepo. Do not edit docs/development-guide/api-errors/codes.mdx by hand — changes will be overwritten on the next sync.

@mintlify

mintlify Bot commented Jul 22, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Nevermined 🟢 Ready View Preview Jul 22, 2026, 12:51 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 22, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Nevermined 🟡 Building Jul 22, 2026, 12:50 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@r-marques

Copy link
Copy Markdown
Member

Worth landing this one: the published catalogue on main has zero BCK.ROUTER.* and zero BCK.CATALOG.* entries, while this regenerated page carries all 9 Router codes and 5 Catalog codes. So those codes are missing from the docs site purely because this PR has not merged — the new Nevermined Router section documents them inline and links here for the canonical catalogue.

It needs a rebase first: it targets docs/development-guide/api-errors/codes.mdx and main has since dropped the docs/ path prefix. Since the page is generated by sync-errors-docs.yml in nvm-monorepo, re-running the sync against current main is probably cleaner than resolving the conflict by hand. Tracked as nevermined-io/nvm-monorepo#2594.

@r-marques

Copy link
Copy Markdown
Member

Heads-up so you don't spend time rebasing this: the problem isn't that this PR is stale, it's that the sync pipeline writes to a path that no longer exists. Fix in https://github.com/nevermined-io/nvm-monorepo/pull/2659.

The docs site moved its content to the repo root, but sync-errors-docs.yml still targets docs/development-guide/api-errors/codes.mdx — which is why this PR carries that path. Rebasing it onto the restructured main would just relocate a file the generator will keep misplacing next run.

It also explains the silence since July: the workflow checks for changes with git diff --quiet, which ignores untracked files, so after the restructure it generated an orphan file, saw "no changes", and exited green.

No action needed here. Once that PR merges, a workflow_dispatch run opens a fresh, correctly-pathed sync PR, and the workflow's existing supersede loop closes every open sync/api-errors-* branch — including this one — automatically.

@eruizgar91

Copy link
Copy Markdown
Member Author

Superseded by #272 (full regeneration of the API errors catalogue).

@eruizgar91 eruizgar91 closed this Aug 4, 2026
auto-merge was automatically disabled August 4, 2026 18:13

Pull request was closed

@eruizgar91
eruizgar91 deleted the sync/api-errors-5e8d407 branch August 4, 2026 18:13
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