chmac / action.tools

Experiments in building an action manager (todo or task manager) based on markdown
GNU Affero General Public License v3.0
2 stars 0 forks source link

Document data format #40

Open chmac opened 2 years ago

chmac commented 2 years ago

@lquenti asked about the documentation for the data format. Good point, it's not clearly laid out.

First step, there is an example repo which shows the format, and hopefully it's relatively self explanatory, but ideally it would be clearly documented also. Here's the example file:

https://raw.githubusercontent.com/chmac/do-test/master/do.md

lquenti commented 2 years ago

Great! The main question would probably be one of scope:

chmac commented 2 years ago

I really like frontmatter for this type of thing. But I also wanted the "inbox" to be the start of the document so that I could easily insert tasks, but actually I think that's backwards, having it last is probably smart.

I found that my support of headings and text and then sub headings is all a bit over the top. Maybe there's a simpler way with multiple files, where each file has an intro, and then only one single list or tasks, with nested child tasks. Then hierarchy could be based on folders.

Another question is does the data live in its own git repo, or could it be part of say a code repo. I liked the idea that the do.md file at the repo root is the task list. So my PR could include a change to the file to close that task.

I'll jot down any other thoughts that come up here, and then we can discuss in more detail next week and share our findings back here afterwards.