Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve manual #296

Open
jackkamm opened this issue Mar 3, 2024 · 0 comments
Open

Improve manual #296

jackkamm opened this issue Mar 3, 2024 · 0 comments

Comments

@jackkamm
Copy link
Collaborator

jackkamm commented Mar 3, 2024

#294 converted the Readme to an Info manual, and did some re-organization, but there are still some improvements to be made both in content and formatting. For example:

  1. Add cindex and vindex decorations so that Info-index is useful when viewing the Info manual in Emacs.
  2. Update old information (e.g. "Compatible caldav servers"?)
  3. Reduce verbosity and make the style/tone more "manual-like". E.g. the "little CalDav rant" section, while interesting, should probably be removed (we could archive it to doc/org-caldav.org_archive, extracting just the relevant details for the manual).

I suggest to do this incrementally (e.g. by section) so that the task is not too large and we can make gradual progress. PRs welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant