Skip to content
This repository has been archived by the owner on Jul 20, 2022. It is now read-only.

[C-633] Polish a few docs pieces #19

Merged
merged 5 commits into from
Jun 30, 2022
Merged

[C-633] Polish a few docs pieces #19

merged 5 commits into from
Jun 30, 2022

Conversation

raymondjacobson
Copy link
Member

@raymondjacobson raymondjacobson commented Jun 29, 2022

This is just the stuff that jumped out at me that I felt could be a bit nicer. Open to any feedback.

Some small structural things:

  • Upgraded docusaurus to latest version on node 14 (gets us nice breadcrumbs)
  • API => Developers
  • Auto expand Developers left-nav
  • Some copy fixes / images / code block structure

I got rid of the 0-index thing. It's kinda silly IMO!

Demo: ray.audius.co

@raymondjacobson raymondjacobson changed the title Polish a few docs pieces [C-633] Polish a few docs pieces Jun 29, 2022
@linear
Copy link

linear bot commented Jun 29, 2022

C-633 Docs polish pass

Copy link
Contributor

@nicoback2 nicoback2 left a comment

Choose a reason for hiding this comment

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

Looks great!
Could you remove the Table of Contents in the body on this page? https://ray.audius.co/token/running-a-node/advanced_setup

Copy link
Contributor

@sliptype sliptype left a comment

Choose a reason for hiding this comment

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

Looks great! I noticed on the top level Developers page the JavaScript SDK tile just says "7 items", can we override that with some better text?
image

@@ -0,0 +1 @@
/Users/ray/Documents/Audius/docs.audius.org/typedoc-plugin-audius-theme
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there might be something wrong with the init-sdk-docgen command creating this file for some reason

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, seems like it's not idempotent. Running it multiple times causes it to create this file

Copy link
Member Author

Choose a reason for hiding this comment

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

fun! i can try to fix that on this PR

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks! I don't know enough about symlinks to understand why this is happening haha

docs/developers/sdk/index.md Show resolved Hide resolved
@raymondjacobson
Copy link
Member Author

Looks great! I noticed on the top level Developers page the JavaScript SDK tile just says "7 items", can we override that with some better text? image

Unfortunately I don't think there's a way to override. In the future we could roll our own index page here, but felt that this was at least kinda nice to have. Docusaurus does the same thing: https://docusaurus.io/docs/next/category/guides

@raymondjacobson raymondjacobson merged commit d31e6a7 into main Jun 30, 2022
@raymondjacobson raymondjacobson deleted the rj-cleanup branch June 30, 2022 07:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants