Skip to content

feat: new help scaffold for v12 - #787

Open
Skidz0r wants to merge 2 commits into
criticalmanufacturing:developmentfrom
Skidz0r:development-159554-mkdocs-investigation
Open

Skidz0r wants to merge 2 commits into
criticalmanufacturing:developmentfrom
Skidz0r:development-159554-mkdocs-investigation

Conversation

@Skidz0r

@Skidz0r Skidz0r commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

With this feature the new help package scaffold is now generated with mkdocs.

image

The folder structure is as follows (for a tenant called "cmf"):

image

The tests were made in a way that a new scaffold for v12 is evaluated not only in the folder structure but content too

@Skidz0r Skidz0r closed this Sep 9, 2026
@Skidz0r Skidz0r reopened this Sep 9, 2026
@Skidz0r
Skidz0r changed the base branch from main to development September 9, 2026 14:42

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.

If the site, is the build, then we don't want it in the template itself right?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes correct, after testing this is true, fixed

@@ -0,0 +1,8 @@
nav:

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.

If we are simply having "User Guide", "Release Notes", etc.

How are we splitting from the dependencies?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Currently we are separating each user guide and the rest of the pages per project (as alligned previously). Please check

@Skidz0r Skidz0r changed the title Development 159554 mkdocs investigation feat: new help scaffold for v12 Sep 16, 2026
@Skidz0r
Skidz0r marked this pull request as ready for review September 16, 2026 10:05
@Skidz0r Skidz0r self-assigned this Sep 16, 2026
"contentToPack": [
{
"source": "site/**",
"target": ""

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

add site

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added

@Skidz0r
Skidz0r force-pushed the development-159554-mkdocs-investigation branch from e5b91a3 to c374226 Compare September 21, 2026 10:47
Comment thread cmf-cli/Commands/new/HelpCommand.cs 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.

3 participants