-
Notifications
You must be signed in to change notification settings - Fork 42
Open
@Phrogz
Description
I'd love to be able to consume this fantastic information you've created and provide an alternative visualization for it. For that, it would be far easier to consume a database that has discrete change entries with fields like: version, category, title, class, method, summary, overview, reason, discussion, documentation, example_code, notes, and so on.
The contents of many of these fields could/would be Markdown, and the full Markdown or HTML as present today could be generated from them.
Pros
- People (like me) could consume the core data programmatically more easily
- I think it would be more clear how to add new features in a consistent manner.
- Would allow slicing the data different manners, e.g. creating a view that covers only the
Stringclass across all versions, or only the changes from 3.0 to 3.1. - (maybe not a pro?) The visual presentation would be forced to be consistent. For example,
Notes:vs.Note:
Cons
- A fair bit of scraping work (or manual conversion) would be need to convert the existing data
- Removes the ability for custom presentation for a specific item, if desired. For example, if there was only one
notesvalue per entry, or oneexample_codesection, but you wanted two separate notes labeled separately. - Hand-editing Markdown-in-YAML does not have nice Markdown syntax highlighting.
Metadata
Metadata
Assignees
Labels
No labels