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

docs: add some existing conventions to the docs style guide #13809

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

agilgur5
Copy link
Contributor

Motivation

These are existing conventions that we try to follow most of the time and I figured it would be better to have a centralized link for these. I would previously say "conventionally" / "by convention" or "consistently" / "to be consistent" or link to a past example during review, but having a single source-of-truth is better.

Modifications

note a few that have recently been mentioned off the top of my head:

Verification

make docs passes

Future Work

  1. add more existing conventions

just a few that have recently been mentioned off the top of my head:
- relative links
- "Argo" vs. "Argo Workflows"
- In-line version annotations
- embedded example files

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix labels Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant