Skip to content

Add documentation to Vitepress Docs page#292

Merged
Entenwilli merged 40 commits into
mainfrom
docs
Jul 23, 2025
Merged

Add documentation to Vitepress Docs page#292
Entenwilli merged 40 commits into
mainfrom
docs

Conversation

@Entenwilli

@Entenwilli Entenwilli commented Jun 3, 2025

Copy link
Copy Markdown
Member

This PR contains several documentation pages for the vitepress docs

@Entenwilli Entenwilli self-assigned this Jun 3, 2025
@Entenwilli Entenwilli added enhancement New feature or request core Related to the core DFD/PCM data flow analysis documentation Updates the documentation / wiki labels Jun 3, 2025
@Entenwilli Entenwilli added this to the 5.0.0 milestone Jun 3, 2025
@Entenwilli Entenwilli linked an issue Jun 3, 2025 that may be closed by this pull request
@Entenwilli Entenwilli force-pushed the docs branch 3 times, most recently from 8a307e9 to 1dadf69 Compare June 24, 2025 07:38
@Entenwilli Entenwilli marked this pull request as ready for review July 1, 2025 09:23
@Entenwilli Entenwilli force-pushed the docs branch 2 times, most recently from 396b18e to 08482ba Compare July 10, 2025 09:44

@sebinside sebinside left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for these comprehensive additions! After having a quick look, here are a couple of comments. As discussed previously, for the sake of merging this quickly, these are only comments and no direct change requests.

Comment thread docs/wiki/pcm/index.md
Comment thread docs/wiki/gettingstarted.md
Comment thread docs/.vitepress/config.mts
Comment thread docs/.vitepress/config.mts Outdated
Comment thread docs/wiki/dsl/index.md
Comment thread docs/wiki/webeditor/assignments.md Outdated
Comment thread docs/wiki/webeditor/assignments.md
Comment thread docs/wiki/eclipse/index.md Outdated
Comment thread docs/wiki/glossary.md Outdated
Comment thread docs/wiki/glossary.md Outdated
Comment thread docs/.vitepress/config.mts Outdated
Comment thread docs/index.md Outdated
Comment thread docs/.vitepress/config.mts
Comment thread docs/wiki/webeditor/shortcuts.md
Comment thread docs/wiki/development/running-locally.md
@Kr0nox

Kr0nox commented Jul 15, 2025

Copy link
Copy Markdown
Contributor

And for me locally the site currently does not build due to incorrect image paths

Comment thread docs/.vitepress/config.mts Outdated
Comment thread docs/wiki/development/eclipse.md
Comment thread docs/wiki/development/eclipse.md Outdated
Comment thread docs/wiki/dsl/source.md Outdated
Comment thread docs/wiki/eclipse/index.md Outdated
Comment thread docs/wiki/running-locally.md Outdated

@01Parzival10 01Parzival10 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.

Just some typos and clarifications

Comment thread docs/wiki/gettingstarted.md Outdated
Comment thread docs/.vitepress/config.mts Outdated
Comment thread docs/wiki/dsl/index.md Outdated
Comment thread docs/wiki/dsl/source.md Outdated
Comment thread docs/wiki/dfd/index.md Outdated
Comment thread docs/wiki/glossary.md
Comment thread docs/wiki/glossary.md
Comment thread docs/wiki/glossary.md Outdated
Comment thread docs/wiki/glossary.md Outdated

@01Parzival10 01Parzival10 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.

LGTM

@Entenwilli Entenwilli merged commit 1931ccb into main Jul 23, 2025
1 check passed
@Entenwilli Entenwilli deleted the docs branch July 23, 2025 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Related to the core DFD/PCM data flow analysis documentation Updates the documentation / wiki enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add glossary to document our terminology

5 participants