Skip to content

Review and revise documentation #63

Open
3 of 3 issues completed
Open

Description

@SashankBhamidi

Review and revise each of the following in a separate PR against latest (not stable — stable is several weeks behind and missing most of what's below). Live build: https://calendaring-jmap.readthedocs.io/en/latest/

Source lives under docs/. Sections 1-4 are ordered by priority, highest first, since this is a time-boxed pass and later items can slip to a follow-up if needed. After section 4, pick whatever order you'd like.

  1. Writing documentation standard
  • docs/contribute.rst — "Writing documentation" section. Rewrite this to whatever standard you think docs should follow; this becomes the house style for calendaring-jmap and gets carried over to the other pycal repos afterward, so make it exactly what you want it to be.
  1. First-touch path (what every new reader hits first)
  • README.md
  • docs/index.rst
  • docs/tutorials/quickstart.rst
  • docs/how-to/install.rst
  • docs/how-to/authenticate.rst
  1. Core how-to guides (the primary use case)
  • docs/how-to/calendars.rst
  • docs/how-to/events.rst
  • docs/how-to/sync.rst
  • docs/how-to/errors.rst
  1. Secondary how-to guides
  • docs/how-to/scheduling.rst
  • docs/how-to/free-busy.rst
  • docs/how-to/attachments.rst
  • docs/how-to/contacts.rst
  • docs/how-to/tasks.rst
  • docs/how-to/push-notifications.rst
  • docs/how-to/convert.rst
  • docs/how-to/logging.rst
  • docs/how-to/example-sync-cache.rst
  • docs/how-to/index.rst
  1. Explanation
  • docs/explanation/index.rst
  • docs/explanation/design.rst
  1. Reference (mostly autodoc wiring, short prose sections only)
  • docs/reference/index.rst, client.rst, async_client.rst, objects.rst, errors.rst, constants.rst, session.rst, convert.rst
  • docs/reference/server-compatibility.rst
  1. Project pages
  • docs/contribute.rst (rest of the file, outside "Writing documentation")
  • docs/release.rst
  • docs/security.rst
  • docs/changelog.rst

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions