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

Evergreen docs polish #4136

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

Evergreen docs polish #4136

wants to merge 1 commit into from

Conversation

oxve
Copy link
Contributor

@oxve oxve commented Sep 19, 2024

Ran it through the linter and fixed errors and warnings.

b/318730771

Ran it through the linter and fixed errors and warnings.

b/318730771
@oxve oxve enabled auto-merge (squash) September 19, 2024 21:53
Copy link
Contributor

@jonastsai jonastsai left a comment

Choose a reason for hiding this comment

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

Others are good to me except manually numbered the numbered list

@@ -27,32 +27,32 @@ return and complete the following steps.
git checkout tags/24.lts.40
```

1. Enter the top-level of the Cobalt directory
2. Enter the top-level of the Cobalt directory
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we update the number of markdown numbered list manually?

Leave it as 1. and allow the render to automatic numbering should be good enough.

We can easily insert/remove or update the order of the list without affecting others.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll revert that part.

I updated it because g3doc recommends using "correct" numbering. Markdown supports both ways and I didn't see any preference in the developer site docs. The developer site markdown formatter don't seem to touch them unlike the regular g3doc markdown formatter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants