Skip to content

⚙️ [Maintenance]: Root Functions landing pages are now covered#409

Draft
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
plan-functions-index
Draft

⚙️ [Maintenance]: Root Functions landing pages are now covered#409
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
plan-functions-index

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

Modules can now carry an authored src/functions/public/index.md as the Functions landing page with workflow coverage that keeps the published docs artifact from regressing.

Changed: Authored Functions landing pages stay published

Workflow fixtures now include a root src/functions/public/index.md, and the workflow validation checks that documentation generation publishes it as outputs/docs/index.md with the authored content intact.

This keeps the current Document-PSModule behavior explicit for module authors who want the top-level Functions page to be written by hand before readers drill into grouped command sections.

Technical Details

  • Added root src/functions/public/index.md fixtures to both tests/srcTestRepo and tests/srcWithManifestTestRepo.
  • Extended Workflow-Test-Default.yml and Workflow-Test-WithManifest.yml to rerun on fixture changes and to assert the generated docs artifact contains the authored root index.
  • Confirmed the existing move logic in Build-PSModuleDocumentation.ps1 already maps root src/functions/public/index.md to outputs/docs/index.md.
  • Implementation plan progress: completed the first slice for authored root indexes; placeholder-driven generated tables remain for a later slice.
Related issues

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Fail ❌
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

Super-linter detected linting errors

For more information, see the GitHub Actions workflow run

Powered by Super-linter

MARKDOWN
/github/workspace/tests/srcWithManifestTestRepo/src/functions/public/index.md:6 error MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "Functions"]

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.

1 participant