You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, the prepare-files.mts script needs to convert the docs site configurations at config.json in each version of the docs to a format that Docusaurus can ingest. Let's replace the config.json format with this format so we don't need to perform the conversion.
Warning: the docspaths workflow in shared-workflows relies on the current structure of each docs version's config.json file. Other workflows might as well. Make sure nothing breaks when moving to the Docusaurus-native schema.
Steps:
Edit scripts/prepare-files.mts to accept the Docusaurus config format as an input in addition to the legacy docs/config.json format
Update the docpaths workflow to accept the Docusaurus config format in addition to the legacy format
Migrate all docs/config.json files to the Docusaurus config format
Edit scripts/prepare-files.mts to remove the configuration transformation and only move the config file to the new location.
Update the docpaths workflow to only accept the Docusaurus config format
The text was updated successfully, but these errors were encountered:
Getting the new docs engine to accept both the old and new config structures:
@docusaurus/plugin-content-docs doesn't seem to export functions to validate instances of the SidebarsConfigtype. However, there is code to validate the legacy config structure.
Currently, the prepare-files.mts script needs to convert the docs site configurations at
config.json
in each version of the docs to a format that Docusaurus can ingest. Let's replace theconfig.json
format with this format so we don't need to perform the conversion.Warning: the docspaths workflow in
shared-workflows
relies on the current structure of each docs version'sconfig.json
file. Other workflows might as well. Make sure nothing breaks when moving to the Docusaurus-native schema.Steps:
scripts/prepare-files.mts
to accept the Docusaurus config format as an input in addition to the legacydocs/config.json
formatdocpaths
workflow to accept the Docusaurus config format in addition to the legacy formatdocs/config.json
files to the Docusaurus config formatscripts/prepare-files.mts
to remove the configuration transformation and only move the config file to the new location.docpaths
workflow to only accept the Docusaurus config formatThe text was updated successfully, but these errors were encountered: