Nice summary of your approach. I am curious about your choice to use reStructuredText
Since I am mostly writing my planning docs for myself (and the AI) I tend to use markdown in a WYSIWYG editor like Obsidian. This looks beautiful to me as I am working with it.
And I can easily script over it and its internal linking.
Do you just used the two pane editor VS studio plugin, or do you have some WYSIWYG approach?
I do get frustrated on occasion about the limitations on MD. But it seems the loss of WYSIWYG at least for my own docs is pretty big, at least for me.
it's a pretty minor detail, but in cursor/vscode there are just more syntax highlighting variants for different rst tokens (i don't use the preview mode, which definitely contributes to my frustration with md)
Got it, you might mess around with a good previewer like Obsidian or maybe a previewer for other formats. it is so easy on the eyes to see beautifully formatted docs. I love coding with code and docs vague sync. I find that AI gets lost on larger applications w/o architecture docs to remind it how things work and commitments we have made. Still this is very much a work in progress, as even with my docs, Claude forgets so often! I think maybe there will be a way of structuring the docs so it remembers to look at them at the right times. (but so far I have not succeeded in this!)
Nice summary of your approach. I am curious about your choice to use reStructuredText
Since I am mostly writing my planning docs for myself (and the AI) I tend to use markdown in a WYSIWYG editor like Obsidian. This looks beautiful to me as I am working with it.
And I can easily script over it and its internal linking.
Do you just used the two pane editor VS studio plugin, or do you have some WYSIWYG approach?
I do get frustrated on occasion about the limitations on MD. But it seems the loss of WYSIWYG at least for my own docs is pretty big, at least for me.
apologies for the late reply here, just saw this!
it's a pretty minor detail, but in cursor/vscode there are just more syntax highlighting variants for different rst tokens (i don't use the preview mode, which definitely contributes to my frustration with md)
Got it, you might mess around with a good previewer like Obsidian or maybe a previewer for other formats. it is so easy on the eyes to see beautifully formatted docs. I love coding with code and docs vague sync. I find that AI gets lost on larger applications w/o architecture docs to remind it how things work and commitments we have made. Still this is very much a work in progress, as even with my docs, Claude forgets so often! I think maybe there will be a way of structuring the docs so it remembers to look at them at the right times. (but so far I have not succeeded in this!)
Please please please let me in the beta 😉