Conversation
* Critical voices said the documentation many places looks like a personal opinionated blog. I've tried dealing a bit. * The "about"-file is big and contains too much different information. Probably some of the information should be split out or moved to other places. As for now, I've slashed some content that seemed less up-to-date and/or useful. AI Prompts (claude-sonnet-4-6): prompt: I'm going to improve the documentation, the docs under docs/source as well as docstrings in the code (but not the text documents under the project root nor docs/design). In this session I want to do all the work myself, but I'd like some suggestions and thoughs on what is the priority. I was told: (...) The docs contain a lot of outdated, personal editorializing and opinions, which would be fine on a blog, but not so much in documentation, except as a "Design defense" explanation document. prompt: please comment on my changes, and fix typos/grammar errors followup-prompt: (the changes can be found in) ~/caldav, commit 80901d3 followup-prompt: commit prompt: please comment on my changes, and fix typos/grammar errors followup-prompt: commit prompt: do you see anything that is obviously outdated? follow-prompt: Please convert the markdown link to RST followup-prompt: Fix typos.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Various work on the documentation.
Human-written, with some aid from Claude identifying the most important changes, as well as fixing typos.