Skip to content

chore: docs & wiki updated - #640

Open
artacho-xitaso wants to merge 2 commits into
devfrom
chore-update-docs
Open

chore: docs & wiki updated#640
artacho-xitaso wants to merge 2 commits into
devfrom
chore-update-docs

Conversation

@artacho-xitaso

Copy link
Copy Markdown
Contributor

MR: Documentation Cleanup — fix outdated references

Branch: chore-update-docsdev


Summary

Brings the in-repo docs/ and mirrored wiki/ pages back in line with the current code. Fixes references left stale after the "Mnestix API" → Mnestix Proxy + Mnestix AAS Generator split, the components/apis/utils_components/api/util
folder renames, the Templates/Blueprints refactor, and various drifted script names, env vars, and paths.


Changes

docs/FrontendStructure.md

  • Regenerated from the real tree: _components (was /components), lib/api + lib/util (were apis/utils), added stores, i18n, and the product route.

Component rename (Mnestix API → AAS Generator / Proxy)

  • wiki/Docker-Compose-Files.md — service mnestix-apimnestix-aas-generator; fixed dead Docker Hub links + docker pull commands; 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-existent yarn prettier; yarn openapi:generate → real generate-aas-apis / generate-mnestix-apis; corrected openapitools.json paths; .eslintignoreignores in eslint.config.js.
  • wiki/Getting-Started-with-Developing.md — dropped invalid yarn prettier.
  • wiki/Adding-Languages.md — "three languages" → four (added Nederlands / nl).
  • wiki/How-to-Create-Custom-Submodel-Visualizations.mdSubmodelCustomVisualizationMap filename/export corrected to singular; refreshed stale map entries; fixed findValueByIdShort signature (added the semanticId argument, two call sites).
  • wiki/Mnestix-Configuration-Settings.md — documented SERIALIZATION_API_URL; removed the dead AAS_LIST_V2_FEATURE_FLAG section (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).

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/FrontendStructure.md Outdated
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