Skip to content

Auto-generate tableOfContents.md #15

@Andros-Spica

Description

@Andros-Spica

Although useful for tidying up the documentation content and displaying it online, creating and editing those files manually is a cumbersome and repetitive task for authors.

We could add extra fields (arrays) in NASSA.yml that specify the titles and/or URLs of each documentation file. Then create a workflow that generate the tableOfContents using a general Table of Contents layout and the content of these fields.

The fields could be something along these lines, keeping the differentiation between generic and implementation levels:

documentation:

  • title:
    url:

implementations:

  • language: NetLogo
    ...
    documentation:
    • title:
      url:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions