How-to guides
v0.0.2
Each how-to guide covers one task with Mishka Document: set a site up, create a document, add and publish versions, write pages and notes, organize the contents, propose a change with a draft, show documents on your site, track reported issues, and write documents from code.
Pick the guide for the job in front of you. The pages below show each one with a short summary.
- Set up documents on a site Set up Mishka Document on a Mishka CMS site, then check it against the version you run and repair or update its components and sample pages.
- Create a document Create a Mishka Document in the admin: give it a name, address and language, add a translation, and archive or restore it when needed.
- Add, clone and publish versions Add a version to a Mishka document, copy an existing one with its pages and notes, choose the latest, and make a copy independent of its source.
- Write pages and notes Add a page to a Mishka document, write its text with code blocks and components in the editor, and add notes that readers can jump to.
- Organize the contents of a version File Mishka Document pages under parents, order them, choose a front page, and add group headings to shape the contents and page addresses.
- Propose a change with a draft Propose a change to a page or note as a draft, review it in two steps, and let Mishka Document apply it when both reviews approve.
- Show documents on your site Show Mishka documents on a site with the sample pages, give a document its own address, and build a documentation page from its blocks.
- Track reported issues Record issues about a Mishka Document page or note, discuss them in comments, and move each through open, in progress, resolved and closed.
- Write documents from code Create a Mishka document, a version, a page and a note from Elixir with Ash, and copy a version into the next release in a script.