streetsidesoftware
Document using extra dicts with pre-commit
In particular, the overrides doc might better be part of the main docs on the website, but I admit to being confused about where and how to contribute to the main docs at the present time.
I'd love to help with them though.
In the meantime I hope you find this documentation effort useful.
I'm happy to make any changes you request. Thank you for great software!
Thank you for the review, will update accordingly, soon. I appreciate the suggestions, I think they make sense. I am happy to have to chance to have a second opinion on what I write; that hasn't been the case for a while, to my documentation's detriment.
I've converted this PR to a draft temporarily as I am making substantial changes based on the review comments (as you will see shortly), and want you to see things as they develop rather than waiting until I've made all my changes.
Under docs/ I am considering dropping the README- prefix and lower casing the names. Does that make sense to you?
I'm keeping my changes in separate commits to (hopefully) easily revert something that is not wanted.
@danielfdickinson,
I left a lot of comments. I hope you don't find it too daunting.
Kind regards, Jason
@Jason3S I appreciate the comments quite a lot. I think it is great for getting back into 'real work' mode (I've been off work for a few years due to a major crisis, and your detailed explanations and suggestions are really reminding me how get to the level I want to be at).
Sorry for the delay on this; I haven't forgotten, just haven't had the right combination of available time and energy to work on this.
@Jason3S these docs have already helped me a lot, how about merging them as is and addressing your remaining comments later?
@flying-sheep Hi! I'm glad the docs have helped as is :slightly_smiling_face:
I had quite a bit of 'life stuff' come up, but I also got into what I thought was a shorter term side project that I was focusing on. Since I've realized that it won't be done as quickly as I had expected, I'm planning on scheduling that for a longer term, and making time for this. (Thank you for reminding me of it).
My thought is to make the main doc a reference style. I may also add a small walk-through style, but that remains to be seen.
That said, I wonder if it'd be better to merge as a clearly labelled work in progress, and do pull requests to modify separately rather than to try to have an ideal single pull request. That's up to @Jason3S though.
Yeah, that’s what I had in mind! Better to get things out there instead of leaving them in a hard to find spot for extended periods of time.