chore: docs & wiki updated - #640
Open
artacho-xitaso wants to merge 2 commits into
Open
Conversation
artacho-xitaso
requested review from
GailMelanie,
XAlinaGS and
hofermo
as code owners
August 13, 2026 15:17
Contributor
There was a problem hiding this comment.
Pull request overview
Updates in-repo docs/ and mirrored wiki/ pages to match the current Mnestix Browser structure and the “Mnestix API” split into Mnestix Proxy + Mnestix AAS Generator, plus assorted command/path/reference refreshes.
Changes:
- Refreshes documentation to reflect current folder structure (
_components,lib/api,lib/util, etc.) and current feature/content naming. - Updates wiki pages to reference Mnestix AAS Generator instead of the deprecated Mnestix API where applicable, including Docker Hub links and compose service naming.
- Updates various developer docs (scripts, OpenAPI generation commands, supported languages list, visualization mapping + helper usage examples).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
docs/FrontendStructure.md |
Regenerated frontend tree/structure documentation to match current src/ layout. |
wiki/Role-Based-Access-Control.md |
Updates admin Settings section naming to match current UI terminology. |
wiki/Mnestix-Configuration-Settings.md |
Adds SERIALIZATION_API_URL, updates API references/links to AAS Generator, removes stale feature-flag section. |
wiki/Maintaining.md |
Removes non-existent prettier command reference and documents current OpenAPI client generation scripts/paths. |
wiki/Keycloak-Configuration.md |
Updates Keycloak-related reference from “Mnestix API” to “Mnestix AAS Generator” with corrected Docker Hub link. |
wiki/How-to-Create-Custom-Submodel-Visualizations.md |
Updates map filename/export naming and aligns findValueByIdShort examples with current signature. |
wiki/Getting-Started-with-Developing.md |
Removes invalid yarn prettier reference from script highlights. |
wiki/Feature-Overview.md |
Updates the list of tailored submodel visualizations to match current mappings. |
wiki/Docker-Compose-Files.md |
Renames compose service references/images from mnestix-api to mnestix-aas-generator and fixes ports/links. |
wiki/Adding-Languages.md |
Updates supported language count/list to include Dutch (nl). |
wiki/_Sidebar.md |
Fixes case-sensitive wiki link for the custom submodel visualizations page. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
MR: Documentation Cleanup — fix outdated references
Branch:
chore-update-docs→devSummary
Brings the in-repo
docs/and mirroredwiki/pages back in line with the current code. Fixes references left stale after the "Mnestix API" → Mnestix Proxy + Mnestix AAS Generator split, thecomponents/apis/utils→_components/api/utilfolder renames, the Templates/Blueprints refactor, and various drifted script names, env vars, and paths.
Changes
docs/FrontendStructure.md_components(was/components),lib/api+lib/util(wereapis/utils), addedstores,i18n, and theproductroute.Component rename (Mnestix API → AAS Generator / Proxy)
wiki/Docker-Compose-Files.md— servicemnestix-api→mnestix-aas-generator; fixed dead Docker Hub links +docker pullcommands; label + port typo (5054 → 5064).wiki/Keycloak-Configuration.md— dead Docker Hub link fixed; typo "Mnesitx".wiki/Mnestix-Configuration-Settings.md— three dead Docker Hub links fixed; "There also exists the Mnestix API" prose updated to Generator/Proxy split.Stale commands / paths / facts
wiki/Maintaining.md— removed non-existentyarn prettier;yarn openapi:generate→ realgenerate-aas-apis/generate-mnestix-apis; correctedopenapitools.jsonpaths;.eslintignore→ignoresineslint.config.js.wiki/Getting-Started-with-Developing.md— dropped invalidyarn prettier.wiki/Adding-Languages.md— "three languages" → four (added Nederlands /nl).wiki/How-to-Create-Custom-Submodel-Visualizations.md—SubmodelCustomVisualizationMapfilename/export corrected to singular; refreshed stale map entries; fixedfindValueByIdShortsignature (added thesemanticIdargument, two call sites).wiki/Mnestix-Configuration-Settings.md— documentedSERIALIZATION_API_URL; removed the deadAAS_LIST_V2_FEATURE_FLAGsection (flag no longer exists in code).Naming drift
wiki/Role-Based-Access-Control.md— settings tabs → "ID structure, Infrastructures, Role management".wiki/Feature-Overview.md— corrected the tailored-visualization list (dropped "Digital Nameplate", added the actually-mapped submodels).wiki/_Sidebar.md— fixed link casing for the custom-visualizations page (GitHub wiki links are case-sensitive).