Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update expected structure of generate output when cps-mdoc #51

Closed
Tracked by #48
miroslavpojer opened this issue Oct 23, 2024 · 0 comments · Fixed by #60
Closed
Tracked by #48

Update expected structure of generate output when cps-mdoc #51

miroslavpojer opened this issue Oct 23, 2024 · 0 comments · Fixed by #60
Assignees
Labels
enhancement New feature or request

Comments

@miroslavpojer
Copy link
Collaborator

Background

  • The current output does not fit the cps-mdoc structure expectations.

Feature

  • When no structure is defined - there is no problem.

  • When repository structure is enabled - there is a missing leading _index.md page

  • See the expected structure example

    • features (input dir)
      • _index.md ==> controls Visibility of Top menu Tab button
      • topic folder (See topic introduction in another issue)
        • _index.md ==> control visibility of left menu group item
  • Propose text contents for both index pages: main and side.

    • a horizontal split line is still visible if no text is defined.
    • Hint: Maybe two index page templates could be a solution here.
  • Expected index page metadata:

---
title: Features
toolbar_title: "Features"
description_title: "Brief overview of all mined issues."
description: "This is a comprehensive list and brief overview of all issues."
date: "2024-10-22"
weight: 0
---
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants