About these docs, and telling us when one is wrong

What's here#

The documentation covers Castellan itself and each member of its staff. It's in five parts:

Each agent has an overview first: what it does for you, how it works, and what it asks of you. Some have more articles after it:

• How-to articles walk you through one task, step by step.
• Concept articles explain how something works and why it was made that way.
• Reference articles list everything of one kind: every setting, every tool, every message.
• Troubleshooting articles start from something going wrong and end with it put right.

Articles marked For developers are written for people who build software, and assume you know your way around a repository and a command line. The rest assume nothing.

Finding an article#

Search from the documentation's front page: an article shows when it holds every word you type, the ones whose titles match first. If someone gave you an article's number, type the number.

The version and the date on each article#

Under each article's title:

• Article is its number. Mention it when you write to us, and we'll know exactly which page you mean.
• Applies to is the version of Castellan or of the agent the article was written for, or last checked against.
• Last reviewed is the day it was last checked.

Castellan and its staff update often. When a newer version than the one an article was written for is out, the article says so at its top. A small release rarely changes what an article says; a bigger one (from 0.17 to 0.18, say) may well have, so the article warns you and points you to what changed in the release notes.

Reading as a scroll, or a tome#

Read as, at the top of each article, changes how it looks: Page, as the rest of the site; Scroll, unrolled parchment between two wooden rollers; or Tome, a page of a great leather-bound book, with an illuminated first letter. The words are the same in all three. Your browser remembers the one you chose.

Telling us an article is wrong#

At the end of every article is Is this page right? Choose what's wrong:

1. It's out of date: it describes something that has since changed.
2. Something is wrong: it says something that isn't so.
3. Something is missing: you came looking for something it doesn't say.
4. It's hard to follow: it's right, but it lost you.

Add a line about it if you like, then choose Write to us about it. Your email app opens with a message to us already written, with the article's number and the version it was written for. Look it over, and send it.

A person reads every message. When an article is wrong we correct it, and when it's being rewritten it says so at its top until it's done.

When the docs don't answer it#

Write to us at support@castellan-software.com. Support says what to put in the message so we can help quickly, and what Castellan puts right on its own before you ever have to.