chore: separate API docs from main site #1194
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying documentation with
|
| Latest commit: |
39415a7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://883b2192.documentation-7tp.pages.dev |
| Branch Preview URL: | https://separate-api-docs.documentation-7tp.pages.dev |
|
Cloudflare deployment logs are available here |
mujahidkay
force-pushed
the
separate-api-docs
branch
from
b5e3f37 to
5accbcc
Compare
mujahidkay
changed the title
mujahidkay
commented
Sep 10, 2024
| @@ -38,6 +38,14 @@ export const nav = [ | |||
| ariaLabel: 'Agoric CLI', | |||
| link: '/guides/agoric-cli/', | |||
| }, | |||
| { | |||
| text: 'Agoric API Reference', | |||
There was a problem hiding this comment.
This entry seems apt to me but open to suggestions if we wanna call it something else
dckc
reviewed
Sep 10, 2024
| @@ -38,6 +38,14 @@ export const nav = [ | |||
| ariaLabel: 'Agoric CLI', | |||
| link: '/guides/agoric-cli/', | |||
| }, | |||
| { | |||
| text: 'Agoric API Reference', | |||
There was a problem hiding this comment.
I think we usually include SDK in the name for this stuff:
Suggested change
| text: 'Agoric API Reference', | |
| text: 'Agoric SDK API Reference', |
dckc
approved these changes
Sep 10, 2024
| @@ -229,6 +229,14 @@ export default defineConfig({ | |||
| }, | |||
| ], | |||
| }, | |||
| { | |||
| text: 'Agoric API Reference', | |||
There was a problem hiding this comment.
Suggested change
| text: 'Agoric API Reference', | |
| text: 'Agoric SDK API Reference', |
|
I presume it's OK for me to go ahead and merge this. I keep tripping over the lack of it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #1187
This PR aims to remove agoric-sdk and endo reference docs from docs.agoric.com, adds sidebar corresponding sidebar entries and redirects them to the relevant pages.