Skip to content

Improve JS Ref docs - #2188

Merged
timotheeguerin merged 7 commits into
microsoft:mainfrom
timotheeguerin:docs/better-js-docs
Jul 24, 2023
Merged

Improve JS Ref docs#2188
timotheeguerin merged 7 commits into
microsoft:mainfrom
timotheeguerin:docs/better-js-docs

Conversation

@timotheeguerin

@timotheeguerin timotheeguerin commented Jul 13, 2023

Copy link
Copy Markdown
Member

JS Ref docs was a mess, very hard to read with a lot of duplicate navigation that docusaurus was already providing.

This PR change the following:

  • Remove the extra heading information
  • Make properties show up as a table instead of many different heading
  • Navigation is flattening all the types instead of having a sub folder per type (interface, enum, function, etc.)
    • This one can be a little more arguable that we don't want

Before
image

After
image

@github-actions

Copy link
Copy Markdown
Contributor

Changes in this PR will be published to the following url to try(check status of TypeSpec Pull Request Try It pipeline for publish status):
Playground: https://cadlplayground.z22.web.core.windows.net/prs/2188/

Website: https://cadlwebsite.z1.web.core.windows.net/prs/2188/

@timotheeguerin
timotheeguerin marked this pull request as ready for review July 14, 2023 01:50

@daviwil daviwil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks better!

@timotheeguerin
timotheeguerin enabled auto-merge (squash) July 24, 2023 15:33
@timotheeguerin
timotheeguerin merged commit bc32d92 into microsoft:main Jul 24, 2023
@timotheeguerin
timotheeguerin deleted the docs/better-js-docs branch March 4, 2025 18:33
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.

2 participants