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] Generate ToC for Cookbooks #3781

Merged
merged 2 commits into from Jan 30, 2024
Merged

[docs] Generate ToC for Cookbooks #3781

merged 2 commits into from Jan 30, 2024

Conversation

jackkoenig
Copy link
Contributor

Also put cookbooks in a better order for new users.

Figuring out this CSS was annoying, many thanks to @richardxia for help.

Before:

Screenshot 2024-01-29 at 9 06 55 PM

After:

Screenshot 2024-01-29 at 9 07 08 PM

I do kind of like how we didn't have the "group" bullets as links, but this is sooooo much easier to maintain.

We can also then decide to have more interesting ToC styling, but I at least wanted to make sure we could replicate the styling exactly (or at least, very very close).

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related

Desired Merge Strategy

  • Squash

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

Also put cookbooks in a better order for new users.
@jackkoenig jackkoenig added the Documentation Only changing documentation label Jan 30, 2024
@@ -507,7 +478,7 @@ class CustomBundleFixed(elts: (String, Data)*) extends Record {
}
```

### How do I create a finite state machine (FSM)?
## How do I create a finite state machine (FSM)?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There were accidentally getting grouped under the Bundles heading. See screenshot below of the current version of this page (ie. the one live on the website right now). See how we manually didn't group them under Bundles, but the autogenerated sidebar does have them under it.

Screenshot 2024-01-29 at 9 25 45 PM

Copy link
Member

@richardxia richardxia left a comment

Choose a reason for hiding this comment

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

LGTM

website/src/css/custom.css Outdated Show resolved Hide resolved
Co-authored-by: Richard Xia <rxia@sifive.com>
@jackkoenig jackkoenig merged commit c7418b3 into main Jan 30, 2024
14 checks passed
@jackkoenig jackkoenig deleted the autogenerated-toc branch January 30, 2024 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Only changing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants