Docs

The openplan binary keeps the project docs beside the tasks. A doc is not a file in the checkout. Read and write docs only with openplan doc. Write a new doc with openplan doc create, never as a markdown file in the repository.

A doc name has lowercase letters, digits, and hyphens. create and rename print the name they normalize to. Use that name in the next commands.

openplan doc list                          # the doc tree: name, title
openplan doc get <name>                    # "# Title", then the body
openplan doc get <name> --json             # metadata, parent, children, body
openplan doc create "Release process" --body "…" --parent <name>
openplan doc set <name> "$(cat body.md)"   # replaces the whole body
openplan doc nest <name> <parent>          # "-" moves it to the top level
openplan doc rename <from> <to>            # also changes the title
openplan doc delete <name> --yes