Skip to content
This repository has been archived by the owner on Sep 11, 2021. It is now read-only.

[docs] consider generating long-form script docs from embedded ldoc sections #100

Open
pq opened this issue Jun 1, 2018 · 0 comments
Open
Assignees
Labels
docs enhancement New feature or request

Comments

@pq
Copy link
Collaborator

pq commented Jun 1, 2018

rather than having script docs split into two places:

  • scripts/<author>/<script>.lua (for the menu docs)
  • docs/<author>/script/index.md (for the long form ones)

we might consider pulling the long-form script docs into the script source itself and parsing it out with a custom ldoc filter.

while we're at it, we could define and process some custom tags to do things like build app indexes. things we might want to index include:

  • grid-requiring apps
  • midi-supporting apps
  • arc-friendly ones
  • utilities
  • samples and studies
  • templates
  • experiments?

@tehn: i think you had other ideas?

@pq pq self-assigned this Jun 1, 2018
@pq pq added docs enhancement New feature or request labels Jun 1, 2018
@pq pq mentioned this issue Jun 2, 2018
6 tasks
@pq pq changed the title consider generating long-form script docs from an embedded ldoc section in script source [docs] consider generating long-form script docs from embedded ldoc sections Jun 2, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant