Skip to content

Re-architect the notes.md file(s) #28

Description

@arrdem

At present monolithic notes.md files are used to store user documentation and notes for symbols. This has a number of disadvantages, primarily that the notes files tend to feature several common sections arities, docs, notes and related which are encoded in plain text. Ideally these would be separate data sources within a data store which would be composited/concatenated by an API consumer to produce formatted documentation rather than being hand formatted and hand managed.

Maybe what I want is to break out a docs.md from notes.md, providing both read-docs and read-notes for a Thing.

How can users provide additional metadata (arglists etc.) in the context of a notes store? How does this interact with read-meta for a Thing?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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