Skip to content

website/docs: update style guide#14373

Merged
tanberry merged 24 commits intogoauthentik:mainfrom
dominic-r:sdko/style-guide-2025-04-03
Jun 3, 2025
Merged

website/docs: update style guide#14373
tanberry merged 24 commits intogoauthentik:mainfrom
dominic-r:sdko/style-guide-2025-04-03

Conversation

@dominic-r
Copy link
Member

@dominic-r dominic-r commented May 3, 2025

Signed-off-by: Dominic R dominic@sdko.org<!--
👋 Hi there! Welcome.

Please check the Contributing guidelines: https://docs.goauthentik.io/docs/developer-docs/#how-can-i-contribute
-->

Details

REPLACE ME

Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@dominic-r dominic-r requested a review from a team as a code owner May 3, 2025 13:39
@dominic-r dominic-r changed the title wip website/developer-documentation: update style guide May 3, 2025
@netlify
Copy link

netlify bot commented May 3, 2025 •
edited
Loading

✅ Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 208c545
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/683e12032b60a60008396345
😎 Deploy Preview https://deploy-preview-14373--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented May 3, 2025 •
edited
Loading

✅ Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 208c545
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/683e1203944ba80008726fba

@dominic-r dominic-r changed the title website/developer-documentation: update style guide website/docs: update style guide May 3, 2025
@codecov
Copy link

codecov bot commented May 3, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.76%. Comparing base (4c5fe84) to head (208c545).
Report is 28 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #14373   +/-   ##
=======================================
  Coverage   92.76%   92.76%           
=======================================
  Files         817      817           
  Lines       42197    42197           
=======================================
  Hits        39142    39142           
  Misses       3055     3055
Flag Coverage Δ
e2e 47.55% <ø> (-0.01%) ⬇️
integration 24.38% <ø> (ø)
unit 90.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dominic-r dominic-r marked this pull request as draft May 3, 2025 21:39
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry reviewed May 5, 2025
View reviewed changes
tanberry
tanberry requested changes May 5, 2025
View reviewed changes
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much @dominic-r for these great additions. A few changes requested, and don't remove line 304, but otherwise looks great.

dominic-r and others added 3 commits May 7, 2025 14:14
@dominic-r @tanberry
Update style-guide.mdx
c62bddd 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
@dominic-r @tanberry
Update style-guide.mdx
de9f56e 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
@dominic-r
fix a few review suggestions
c159eec
@dominic-r dominic-r force-pushed the sdko/style-guide-2025-04-03 branch from 704d628 to c159eec Compare May 7, 2025 18:14
@dominic-r dominic-r requested a review from tanberry May 11, 2025 18:20
@dominic-r dominic-r marked this pull request as ready for review May 11, 2025 18:32
tanberry
tanberry reviewed May 30, 2025
View reviewed changes
tanberry
tanberry reviewed May 30, 2025
View reviewed changes
website/docs/developer-docs/docs/style-guide.mdx
Use tables to compare options, list parameters, or summarize information. Ensure tables are concise and avoid nesting complex content. Only use a table when there are 4 or more items. For only 2 or 3 items, use a bullet list.

This section covers the usage of React components within our documentation. Files that use component-based formatting must use the `.mdx` extension.
### Lists
Copy link
Contributor

@tanberry tanberry May 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was wrong, there is a bit of conflict between this PR and the one I worked on today.. I too added a new section to cover Lists... but about the punctuation and capitalization.

Your content is important too; we need a way to add both... let's think on how without having two sections called Lists.

tanberry
tanberry requested changes May 30, 2025
View reviewed changes
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR has some great additions, thank you @dominic-r !

We need to figure out how to handle having two sections both called "Lists"... let;s figure that out then get this merged.

dominic-r and others added 2 commits May 30, 2025 18:50
@dominic-r @tanberry
Update website/docs/developer-docs/docs/style-guide.mdx
d4eb30e 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
@dominic-r
Merge branch 'main' into sdko/style-guide-2025-04-03
a5b7c69
tanberry
tanberry reviewed Jun 2, 2025
View reviewed changes
tanberry
tanberry reviewed Jun 2, 2025
View reviewed changes
@tanberry
Update website/docs/developer-docs/docs/style-guide.mdx
f928729 
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
tanberry
tanberry reviewed Jun 2, 2025
View reviewed changes
@tanberry
Update website/docs/developer-docs/docs/style-guide.mdx
3806930 
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
tanberry
tanberry reviewed Jun 2, 2025
View reviewed changes
@tanberry
Update website/docs/developer-docs/docs/style-guide.mdx
9ede389 
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
tanberry
tanberry approved these changes Jun 2, 2025
View reviewed changes
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge this now, then look at the lists question.

@tanberry tanberry merged commit 08027bf into goauthentik:main Jun 3, 2025
98 checks passed
@dominic-r dominic-r deleted the sdko/style-guide-2025-04-03 branch June 3, 2025 21:10
kensternberg-authentik added a commit that referenced this pull request Jun 6, 2025
@kensternberg-authentik
Merge branch 'main' into dev
79d5bc0 
* main: (97 commits)
  website/docs: update style guide (#14373)
  website/docs: finalize release notes for `2025.6` (#14854)
  providers/rac: apply ConnectionToken scoped-settings last (#14838)
  lib/sync: fix static incorrect label of pages (#14851)
  website/docs: Add FIDO2 references to the documentation (#14826)
  website/docs: add LDAP docs for forward deletion and `memberUid` (#14814)
  stages/authenticator_webauthn: Update FIDO MDS3 & Passkey aaguid blobs (#14801)
  core: bump structlog from 25.3.0 to 25.4.0 (#14834)
  web: bump tar-fs from 3.0.8 to 3.0.9 in /web (#14836)
  website/integrations: Update Zammad SAML Instructions (#14774)
  website/integrations: remove trailing slash from budibase redirect (#14823)
  remove fluff from release notes 2025.6 (#14819)
  web: bump @sentry/browser from 9.22.0 to 9.23.0 in /web in the sentry group across 1 directory (#14776)
  website: bump postcss from 8.5.3 to 8.5.4 in /website (#14787)
  web: bump the esbuild group across 2 directories with 4 updates (#14711)
  core: bump github.com/redis/go-redis/v9 from 9.8.0 to 9.9.0 (#14733)
  core: bump twilio from 9.6.1 to 9.6.2 (#14789)
  website: bump @types/node from 22.15.21 to 22.15.29 in /website (#14808)
  core: bump astral-sh/uv from 0.7.8 to 0.7.9 (#14806)
  core: bump uvicorn[standard] from 0.34.2 to 0.34.3 (#14811)
  ...
cavefire pushed a commit to cavefire/authentik that referenced this pull request Jun 24, 2025
@dominic-r @tanberry @cavefire
website/docs: update style guide (goauthentik#14373)
eb62311 
* wip

Signed-off-by: Dominic R <dominic@sdko.org>

* fix ` ` `

Signed-off-by: Dominic R <dominic@sdko.org>

* Update website/docs/developer-docs/docs/style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update website/docs/developer-docs/docs/style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update website/docs/developer-docs/docs/style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update website/docs/developer-docs/docs/style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* fix a few review suggestions

* review

* lint

* rm examples

* Update website/docs/developer-docs/docs/style-guide.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>

* Update website/docs/developer-docs/docs/style-guide.mdx

Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

* Update website/docs/developer-docs/docs/style-guide.mdx

Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

* Update website/docs/developer-docs/docs/style-guide.mdx

Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

* tweak to bump build

* tweak

---------

Signed-off-by: Dominic R <dominic@sdko.org>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Co-authored-by: Tana M Berry <tana@goauthentik.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tanberry tanberry tanberry approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dominic-r @tanberry