Overture docs update - #448
Open
MitchellShiell wants to merge 8 commits into
Open
Conversation
5 tasks
…diagram Lyric has graduated from under-development to core software, so the two Overview cross-links now point at …/build/core-software/Lyric/overview instead of the old …/docs/under-development/lyric/ path. Also commits the in-flight submission-system.svg diagram update (light/dark styling).
Bring the Lectern Viewer (@overture-stack/lectern-ui) into the Lectern component docs as 04-lecternViewer.md, moved out of the docs site's under-development section. Content pulled from packages/ui (README + docs): the DictionaryTableView and DictionaryEntityRelationshipView components, Storybook quick start, and theming, with the full contributor walkthrough cross-linked to packages/ui/docs rather than duplicated. Screenshots added under docs/assets/.
Lectern has no `develop` branch any more — only `main` — so every `blob/develop/...` link 404s. Retarget them at `main`; LICENSE, apps/server/README.md and generated/DictionaryMetaSchema.json all still exist at those paths. `docs/important-concepts.md` also no longer exists: #299 moved it to pendingDocs/glossary.md, which still carries the four anchors the validation README deep-links to (#dictionary, #schema, #testresult, Also repoints the README's site links, which had gone stale the same way as every other component README.
MitchellShiell
force-pushed
the
overtureDocsUpdate
branch
from
July 30, 2026 17:45
484c097 to
66a2331
Compare
The block opened with four backticks and was never closed, so the ## Field Restrictions heading and all its prose rendered inside a code block, and the #field-restrictions anchor stopped existing. Docusaurus reported it as two broken anchors: the field-properties table on this page links to #field-restrictions, and the site's /use/administration/building-dictionaries page links to /develop/Lectern/dictionaryReference#field-restrictions. Arrived on main with the displayName work; fixed here because this branch already owns this file and the docs site build is failing on it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation for the Overture docs site. No source code changes; the only non-
docs/change is adding.DS_Storeto.gitignore.docs/04-lecternViewer.mdbecomes a three-page section,docs/04-viewer/, written againstpackages/uias it stands onmain.docs/04-viewer/index.md/develop/Lectern/viewer/docs/04-viewer/01-setup.md/develop/Lectern/viewer/setupdocs/04-viewer/02-reference.md/develop/Lectern/viewer/referenceOther changes
docs/01-overview.md: Lyric links repointed; repository tree corrected (commonremoved,uiadded); components table de-indented so it renders, and the Dictionary/Validation npm badges and paths fixed, both having pointed at the client package.docs/02-Setup.md: documents the optionalMONGO_URL, which takes precedence overMONGO_HOST/MONGO_PORT/MONGO_DB.developbranch repointed atmain, anddocs/important-concepts.md#testresultrepointed atpendingDocs/glossary.md#testresult./community/support;docs/assets/submission-system.svgupdated.Rebased onto
mainCurrent with
main, no conflicts. 43 commits absorbed, with one conflict inREADME.mdwhere both sides had repointed the same stale link; this branch's/develop/Lectern/overviewwas kept overmain's olderdocs/core-software/scheme.main's reformat ofdocs/03-dictionaryReference.mdand itsdisplayNameadditions are untouched. The viewer pages were re-checked against the rebasedpackages/ui: entry points,DictionaryTableProps,CustomColumnConfigandMetaValueRendererall match.Known issues, not fixed here
#416: Table View Styling Updates. Recapturable from Storybook, but not needed for this pass.packages/ui/src/index.tsaliasesSchemaTableandToolbarto the samedefaultexport asDictionaryTable, so all three resolve toDictionaryViewerPage. Also in the published1.0.0types. The Reference page routes readers to the/dictionary-tablesubpath instead, and notes the caveat.Columns/DataType.tsxrendersArrayin place of the value type, so array-of-string and array-of-integer look identical.packages/ui/README.mdandpackages/ui/docs/README.mdstill advertise the removedLecternThemeProvider/LecternThemenames.Broken code fence fixed
docs/03-dictionaryReference.mdhad an unclosed four-backtick fence in the "Display Name Example" block, which arrived with thedisplayNamework onmain. It swallowed the## Field Restrictionsheading and everything after it into a code block, so the#field-restrictionsanchor stopped existing and the Docusaurus build failed on two broken anchors: the field-properties table on this page, and the docs site's/use/administration/building-dictionariespage.Originally flagged here as out of scope, then fixed once it broke the site build, since this branch already owns the file.
CI
The Jenkins failure is unrelated to this branch, which changes no build inputs. The shared pipeline runs
npx --yes pnpm install, which resolves to pnpm 11, requiring Node >= 22.13; the agent runs Node 18.16.1.mainfails identically.