diff --git a/DocsDevREADME.md b/DocsDevREADME.md index ee375e6db7..c006e4edc5 100644 --- a/DocsDevREADME.md +++ b/DocsDevREADME.md @@ -26,6 +26,7 @@ Here are some guidelines to follow when writing documentation (everything under - Headers should have the first letter of every word capitalized: `This Is The Header Text`. This is true for all headers (h1, h2, h3, h4). This is also known as [Start Case](https://en.wikipedia.org/wiki/Letter_case). (quick check is: `grep '^## \([^ ].*\)\{0,1\}' site/_posts/.md`) - When writing, you have access to Asides. Here's an [example blog post using an Aside](https://github.com/FusionAuth/fusionauth-site/blob/master/astro/src/content/blog/log4j-fusionauth.mdx). You can assign the following values to the type: `tip` for tips. `note` for things for the user to be aware of. `important` for things the user should pay attention to. `warn` for dangerous actions like deleting a tenant. +- For links, don't use the absolute URL for the FusionAuth website (https://fusionauth.io), only relative URLs. This allows us to deploy to our local and staging environments and not get sent over to prod. ## Docs - Don't use complex breadcrumbs styling in docs. Use `->` because Asciidoc converts this to a nice Unicode arrow. Breadcrumbs should look like this `[breadcrumb]#foo -> bar -> baz#`. When using markdown, use `foo -> bar -> baz{:breadcrumb}`