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

website/docs: add clarification about formatting URLs to Style Guide #13601

Merged
merged 9 commits into from
Mar 21, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
a few additions
Tana M Berry committed Mar 14, 2025
commit e6d7e98c51c40c4adc39f7b91ee4bd059e1b331d
6 changes: 6 additions & 0 deletions website/docs/developer-docs/docs/style-guide.mdx
Original file line number Diff line number Diff line change
@@ -12,12 +12,18 @@ If you find any documentation that doesn't match these guidelines, feel free to

- Try to order the documentation sections in the order that makes it easiest for the user to follow. That is, order the sections in the same order as the actual workflow used to accomplish the task.

- When writng procedural documentation (How Tos) try to follow the workflow in the UI, presenting the exact page(s) they need to navigate, and then the exact fields, tabs, etc that they need to select or fill out. Present the UI components in the document in the same order they appear in the UI.

- Use headings (sub-titles) to break up long documents, and make it easier to find a specific section.

- Add cross-reference links to related content whenever possible.

- You can use standard [Docusaurus-specific features](https://docusaurus.io/docs/next/markdown-features), which include MDX elements such as tabs and admonitions.

## Look and feel of the docs

In general, the visual, "aesthetics" of the technical documentation is intended to be "lean and clean". Both the content (shorter sentences, concise instructions, etc) and the layout strive to have a clean, uncluttered look, with restrained use of colors and large call0outs or announcments. Relatedly, the colors used for our Info and Warning callouts, light blue and light yellow respectively, are reserved for those purposes only.

## Terminology

### authentik names