New Docs #2603
New Docs #2603
Conversation
|
Warning Rate Limit Exceeded@trajan0x has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 49 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe recent updates involve transitioning to Docusaurus for generating static websites, enhancing the documentation system with new API doc generation commands, and refining the UI with thematic and navigational improvements. Additionally, workflow paths and package dependencies have been adjusted to align with these changes. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Deploying sanguine-fe with
|
| Latest commit: |
a137672
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://aad4f234.sanguine-fe.pages.dev |
| Branch Preview URL: | https://new-docs.sanguine-fe.pages.dev |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2603 +/- ##
===================================================
- Coverage 39.59307% 39.58477% -0.00830%
===================================================
Files 179 179
Lines 14548 14546 -2
Branches 80 80
===================================================
- Hits 5760 5758 -2
Misses 8033 8033
Partials 755 755
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
Out of diff range and nitpick comments (3)
docs/bridge/README.md (1)
Line range hint
11-41: Specify the language for code blocks to enable syntax highlighting.- ``` + ```bash $ yarn
$ yarn start
- ``` + ```bash $ yarn build
$ USE_SSH=true yarn deploy
- ``` + ```bash $ GIT_USER=<Your GitHub username> yarn deploy</blockquote></details> <details><summary>docs/bridge/docs/rfq/RFQ.md (1)</summary><blockquote> Line range hint `25-25`: Remove extra blank lines. ```diff - -services/rfq/api/docs/docs.go (1)
86-86: Ensure the summary for the PUT method is clear and concise.Consider rephrasing the summary to "Upsert a quote" to align with the action being performed.
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (9)
docs/bridge/static/img/docusaurus-social-card.jpgis excluded by!**/*.jpgdocs/bridge/static/img/docusaurus.pngis excluded by!**/*.pngdocs/bridge/static/img/favicon.icois excluded by!**/*.icodocs/bridge/static/img/logo.svgis excluded by!**/*.svgdocs/bridge/static/img/undraw_docusaurus_mountain.svgis excluded by!**/*.svgdocs/bridge/static/img/undraw_docusaurus_react.svgis excluded by!**/*.svgdocs/bridge/static/img/undraw_docusaurus_tree.svgis excluded by!**/*.svgdocs/bridge/yarn.lockis excluded by!**/*.lockyarn.lockis excluded by!**/*.lock
Files selected for processing (30)
- docs/bridge/README.md (1 hunks)
- docs/bridge/docs/CCTP/Contracts.md (1 hunks)
- docs/bridge/docs/CCTP/Overview.md (1 hunks)
- docs/bridge/docs/CCTP/Relayer.md (1 hunks)
- docs/bridge/docs/CCTP/category.json (1 hunks)
- docs/bridge/docs/Observability.md (1 hunks)
- docs/bridge/docs/Services/Omnirpc.md (1 hunks)
- docs/bridge/docs/rfq/API/API.md (1 hunks)
- docs/bridge/docs/rfq/API/get-quotes.api.mdx (1 hunks)
- docs/bridge/docs/rfq/API/sidebar.ts (1 hunks)
- docs/bridge/docs/rfq/API/upsert-quote.api.mdx (1 hunks)
- docs/bridge/docs/rfq/Contracts.md (1 hunks)
- docs/bridge/docs/rfq/RFQ.md (1 hunks)
- docs/bridge/docs/rfq/Relayer/Relayer.md (1 hunks)
- docs/bridge/docs/rfq/category.json (1 hunks)
- docs/bridge/docusaurus.config.ts (1 hunks)
- docs/bridge/package.json (1 hunks)
- docs/bridge/sidebars.ts (1 hunks)
- docs/bridge/src/components/HomepageFeatures/index.tsx (1 hunks)
- docs/bridge/src/components/HomepageFeatures/styles.module.css (1 hunks)
- docs/bridge/src/pages/index.tsx (1 hunks)
- docs/bridge/src/pages/markdown-page.md (1 hunks)
- docs/bridge/tsconfig.json (1 hunks)
- lerna.json (1 hunks)
- services/rfq/api/README.md (1 hunks)
- services/rfq/api/client/client.go (2 hunks)
- services/rfq/api/docs/docs.go (2 hunks)
- services/rfq/api/docs/swagger.json (2 hunks)
- services/rfq/api/docs/swagger.yaml (3 hunks)
- services/rfq/api/rest/handler.go (2 hunks)
Files skipped from review due to trivial changes (11)
- docs/bridge/docs/CCTP/category.json
- docs/bridge/docs/rfq/API/sidebar.ts
- docs/bridge/docs/rfq/API/upsert-quote.api.mdx
- docs/bridge/docs/rfq/category.json
- docs/bridge/package.json
- docs/bridge/sidebars.ts
- docs/bridge/src/components/HomepageFeatures/styles.module.css
- docs/bridge/tsconfig.json
- lerna.json
- services/rfq/api/docs/swagger.json
- services/rfq/api/docs/swagger.yaml
Additional comments not posted (6)
docs/bridge/src/pages/markdown-page.md (1)
1-7: LGTM! The Markdown page structure is simple and correctly formatted.docs/bridge/src/pages/index.tsx (1)
1-45: LGTM! The React component for the homepage is well-structured and follows best practices.docs/bridge/docs/CCTP/Overview.md (1)
1-8: LGTM! The CCTP overview is well-documented and provides useful links to related resources.docs/bridge/src/components/HomepageFeatures/index.tsx (1)
1-70: LGTM! The React component for homepage features is well-structured and follows best practices.docs/bridge/docs/rfq/API/get-quotes.api.mdx (1)
1-282: Comprehensive review of the new API documentation.The documentation is well-structured and includes detailed descriptions, parameters, and response schemas. Good use of components to enhance readability and interactivity.
docs/bridge/docs/rfq/Relayer/Relayer.md (1)
1-224: Comprehensive review of the new Relayer documentation.The documentation is thorough and well-organized, covering various aspects of the relayer's functionality, configuration, and operation. It effectively uses Markdown features to enhance readability.
| # RFQ API | ||
|
|
||
| This is the canonical implementation of the RFQ API. It is a RESTful API that allows solvers to post quotes for given bridge routes. |
There was a problem hiding this comment.
Correct the heading format.
- # RFQ API
+ # RFQ APIEnsure the heading starts at the beginning of the line.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| # RFQ API | |
| This is the canonical implementation of the RFQ API. It is a RESTful API that allows solvers to post quotes for given bridge routes. | |
| # RFQ API | |
| This is the canonical implementation of the RFQ API. It is a RESTful API that allows solvers to post quotes for given bridge routes. |
| ### Synapse CCTP | ||
|
|
||
| | Chain | Address | | ||
| | --------- | -------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Arbitrum | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://arbiscan.io/address/0x12715a66773bd9c54534a01abf01d05f6b4bd35e) | | ||
| | Avalanche | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://snowtrace.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | ||
| | Base | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://basescan.org/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | ||
| | Ethereum | [0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E](https://etherscan.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | ||
| | Optimism | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://optimistic.etherscan.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | ||
| | Polygon | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://polygonscan.com/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | ||
|
|
||
| ## Circle Contracts | ||
|
|
||
| Please refer to [this page](https://developers.circle.com/stablecoins/docs/evm-smart-contracts) for Circle contract addresses. |
There was a problem hiding this comment.
Correct the heading level for better document structure.
- ### Synapse CCTP
+ ## Synapse CCTPEnsure that heading levels increment by one level at a time.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ### Synapse CCTP | |
| | Chain | Address | | |
| | --------- | -------------------------------------------------------------------------------------------------------------------------------- | | |
| | Arbitrum | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://arbiscan.io/address/0x12715a66773bd9c54534a01abf01d05f6b4bd35e) | | |
| | Avalanche | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://snowtrace.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| | Base | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://basescan.org/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| | Ethereum | [0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E](https://etherscan.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| | Optimism | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://optimistic.etherscan.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| | Polygon | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://polygonscan.com/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| ## Circle Contracts | |
| Please refer to [this page](https://developers.circle.com/stablecoins/docs/evm-smart-contracts) for Circle contract addresses. | |
| ## Synapse CCTP | |
| | Chain | Address | | |
| | --------- | -------------------------------------------------------------------------------------------------------------------------------- | | |
| | Arbitrum | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://arbiscan.io/address/0x12715a66773bd9c54534a01abf01d05f6b4bd35e) | | |
| | Avalanche | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://snowtrace.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| | Base | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://basescan.org/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| | Ethereum | [0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E](https://etherscan.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| | Optimism | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://optimistic.etherscan.io/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| | Polygon | [0x12715a66773bd9c54534a01abf01d05f6b4bd35e](https://polygonscan.com/address/0x12715a66773BD9C54534a01aBF01d05F6B4Bd35E) | | |
| ## Circle Contracts | |
| Please refer to [this page](https://developers.circle.com/stablecoins/docs/evm-smart-contracts) for Circle contract addresses. |
| **Configuring Metrics** | ||
|
|
||
| 1. Pick a vendor that supports the [prometheus](https://prometheus.io/docs/instrumenting/exporters/) standard. We recommend Grafana for OSS. | ||
| 2. Set the `METRICS_PORT_ENABLED` environment variable to `true` to enable the metrics endpoint. | ||
| 3. Find your metrics on `METRICS_PORT` at `METRICS_PATH` and configure scrapers. | ||
|
|
||
| **Configuring APM** | ||
|
|
||
| Set the `PYROSCOPE_ENDPOINT` environment variable to the endpoint of your [pyroscope instance](https://pyroscope.io/). |
There was a problem hiding this comment.
Use headings instead of emphasis for section titles.
- **Configuring Metrics**
+ ### Configuring Metrics
- **Configuring APM**
+ ### Configuring APMEnsure that section titles are marked as headings for better document structure.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| **Configuring Metrics** | |
| 1. Pick a vendor that supports the [prometheus](https://prometheus.io/docs/instrumenting/exporters/) standard. We recommend Grafana for OSS. | |
| 2. Set the `METRICS_PORT_ENABLED` environment variable to `true` to enable the metrics endpoint. | |
| 3. Find your metrics on `METRICS_PORT` at `METRICS_PATH` and configure scrapers. | |
| **Configuring APM** | |
| Set the `PYROSCOPE_ENDPOINT` environment variable to the endpoint of your [pyroscope instance](https://pyroscope.io/). | |
| ### Configuring Metrics | |
| 1. Pick a vendor that supports the [prometheus](https://prometheus.io/docs/instrumenting/exporters/) standard. We recommend Grafana for OSS. | |
| 2. Set the `METRICS_PORT_ENABLED` environment variable to `true` to enable the metrics endpoint. | |
| 3. Find your metrics on `METRICS_PORT` at `METRICS_PATH` and configure scrapers. | |
| ### Configuring APM | |
| Set the `PYROSCOPE_ENDPOINT` environment variable to the endpoint of your [pyroscope instance](https://pyroscope.io/). |
| "summary": "Get quotes", | ||
| "parameters": [ | ||
| { | ||
| "type": "integer", | ||
| "description": "origin chain id to filter quotes by", | ||
| "name": "originChainID", | ||
| "in": "path", | ||
| "required": true | ||
| "in": "path" | ||
| }, | ||
| { | ||
| "type": "string", | ||
| "description": "origin chain id to filter quotes by", | ||
| "name": "originTokenAddr", | ||
| "in": "path", | ||
| "required": true | ||
| "in": "path" | ||
| }, | ||
| { | ||
| "type": "integer", | ||
| "description": "destination chain id to filter quotes by", | ||
| "name": "destChainID", | ||
| "in": "path", | ||
| "required": true | ||
| "in": "path" | ||
| }, | ||
| { | ||
| "type": "string", | ||
| "description": "destination token address to filter quotes by", | ||
| "name": "destTokenAddr", | ||
| "in": "path", | ||
| "required": true | ||
| "in": "path" | ||
| }, | ||
| { | ||
| "type": "string", | ||
| "description": "relayer address to filter quotes by", | ||
| "name": "relayerAddr", | ||
| "in": "path", | ||
| "required": true | ||
| "in": "path" |
There was a problem hiding this comment.
Ensure consistency in parameter descriptions for better clarity.
- "description": "origin chain id to filter quotes by",
+ "description": "Origin chain ID to filter quotes by",
- "description": "destination chain id to filter quotes by",
+ "description": "Destination chain ID to filter quotes by",
- "description": "relayer address to filter quotes by",
+ "description": "Relayer address to filter quotes by",Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| "summary": "Get quotes", | |
| "parameters": [ | |
| { | |
| "type": "integer", | |
| "description": "origin chain id to filter quotes by", | |
| "name": "originChainID", | |
| "in": "path", | |
| "required": true | |
| "in": "path" | |
| }, | |
| { | |
| "type": "string", | |
| "description": "origin chain id to filter quotes by", | |
| "name": "originTokenAddr", | |
| "in": "path", | |
| "required": true | |
| "in": "path" | |
| }, | |
| { | |
| "type": "integer", | |
| "description": "destination chain id to filter quotes by", | |
| "name": "destChainID", | |
| "in": "path", | |
| "required": true | |
| "in": "path" | |
| }, | |
| { | |
| "type": "string", | |
| "description": "destination token address to filter quotes by", | |
| "name": "destTokenAddr", | |
| "in": "path", | |
| "required": true | |
| "in": "path" | |
| }, | |
| { | |
| "type": "string", | |
| "description": "relayer address to filter quotes by", | |
| "name": "relayerAddr", | |
| "in": "path", | |
| "required": true | |
| "in": "path" | |
| "summary": "Get quotes", | |
| "parameters": [ | |
| { | |
| "type": "integer", | |
| "description": "Origin chain ID to filter quotes by", | |
| "name": "originChainID", | |
| "in": "path" | |
| }, | |
| { | |
| "type": "string", | |
| "description": "origin chain id to filter quotes by", | |
| "name": "originTokenAddr", | |
| "in": "path" | |
| }, | |
| { | |
| "type": "integer", | |
| "description": "Destination chain ID to filter quotes by", | |
| "name": "destChainID", | |
| "in": "path" | |
| }, | |
| { | |
| "type": "string", | |
| "description": "destination token address to filter quotes by", | |
| "name": "destTokenAddr", | |
| "in": "path" | |
| }, | |
| { | |
| "type": "string", | |
| "description": "Relayer address to filter quotes by", | |
| "name": "relayerAddr", | |
| "in": "path" |
|
|
||
| RFQ is a bridge module supported by the Synapse Router that allows different market makers to post quotes on different bridge routes. Users can take these quotes by submitting an on-chain bridge request. In the event these requests are not fulfilled, users can request a refund after a set period of time. | ||
|
|
||
| ### Actors |
There was a problem hiding this comment.
Change heading level to maintain proper sequence.
- ### Actors
+ ## ActorsCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ### Actors | |
| ## Actors |
| "jsonrpc":"2.0", | ||
| "method":"eth_getTransactionCount", | ||
| "params":[ | ||
| "0x230a1ac45690b9ae1176389434610b9526d2f21b", | ||
| "0xec1d40" | ||
| ], | ||
| "id":1 | ||
| }' |
There was a problem hiding this comment.
Replace hard tabs with spaces for consistency in markdown code blocks.
- "jsonrpc":"2.0",
- "method":"eth_getTransactionCount",
- "params":[
- "0x230a1ac45690b9ae1176389434610b9526d2f21b",
- "0xec1d40"
- ],
- "id":1
+ "jsonrpc":"2.0",
+ "method":"eth_getTransactionCount",
+ "params":[
+ "0x230a1ac45690b9ae1176389434610b9526d2f21b",
+ "0xec1d40"
+ ],
+ "id":1Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| "jsonrpc":"2.0", | |
| "method":"eth_getTransactionCount", | |
| "params":[ | |
| "0x230a1ac45690b9ae1176389434610b9526d2f21b", | |
| "0xec1d40" | |
| ], | |
| "id":1 | |
| }' | |
| "jsonrpc":"2.0", | |
| "method":"eth_getTransactionCount", | |
| "params":[ | |
| "0x230a1ac45690b9ae1176389434610b9526d2f21b", | |
| "0xec1d40" | |
| ], | |
| "id":1 | |
| }' |
|
|
||
| The implementation of the rfq api can be found [here](https://github.com/synapsecns/sanguine/tree/master/services/rfq/api). Please note that end-users and solvers will not need to run their own version of the API. | ||
|
|
||
|
|
There was a problem hiding this comment.
Remove extra blank lines.
-Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
|
|
||
| Only Solvers should be writing to the API, end-users need only read from the `/quotes` endpoint. | ||
|
|
||
| **Authentication** |
There was a problem hiding this comment.
Use a heading instead of emphasis for "Authentication".
- **Authentication**
+ ### AuthenticationCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| **Authentication** | |
| ### Authentication |
|
|
||
|
|
||
|
|
||
| **Running with Docker** |
There was a problem hiding this comment.
Use a heading instead of emphasis for "Running with Docker".
- **Running with Docker**
+ ### Running with DockerCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| **Running with Docker** | |
| ### Running with Docker |
|
|
||
| The CCTP relayer is an off-chain service aimed at fulfilling transactions requested through the [CCTP Contracts](./Contracts.md). The relayer is responsible for fetching attestations from the [Circle API](https://developers.circle.com/stablecoin/reference) and submitting them to the CCTP contracts. Anyone can run a relayer. | ||
|
|
||
| ### Architecture |
There was a problem hiding this comment.
Change heading level to maintain proper sequence.
- ### Architecture
+ ## ArchitectureCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ### Architecture | |
| ## Architecture |
There was a problem hiding this comment.
Actionable comments posted: 1
Out of diff range and nitpick comments (2)
docs/bridge/README.md (2)
Line range hint
17-17: Specify the language for the code block to enhance readability.- ``` + ```bash
Line range hint
25-25: Specify the language for the code block to enhance readability.- ``` + ```bash
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/ui-preview.yaml (2 hunks)
- docs/bridge/README.md (2 hunks)
Files skipped from review due to trivial changes (1)
- .github/workflows/ui-preview.yaml
Additional Context Used
LanguageTool (1)
docs/bridge/README.md (1)
Near line 7: Loose punctuation mark.
Context: ...Docsyarn docusaurus gen-api-docs all: <!--todo: needs to be done from ci to e...
Additional comments not posted (1)
docs/bridge/README.md (1)
Line range hint
11-11: Installation command looks good.
There was a problem hiding this comment.
Actionable comments posted: 5
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (2)
docs/bridge/static/img/undraw_docusaurus_mountain.svgis excluded by!**/*.svgyarn.lockis excluded by!**/*.lock
Files selected for processing (3)
- CODEOWNERS (1 hunks)
- docs/bridge/README.md (1 hunks)
- package.json (1 hunks)
Files skipped from review due to trivial changes (2)
- CODEOWNERS
- package.json
Additional Context Used
LanguageTool (1)
docs/bridge/README.md (1)
Near line 6: Loose punctuation mark.
Context: ...Docsyarn docusaurus gen-api-docs all: <!--todo: needs to be done from ci to e...
| @@ -0,0 +1,28 @@ | |||
| # Website | |||
There was a problem hiding this comment.
Ensure headings are surrounded by blank lines for better readability.
+ #
# Website
+ #Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| # Website | |
| # | |
| # Website | |
| # |
|
|
||
| ## Generating API Docs | ||
|
|
||
| `yarn docusaurus gen-api-docs all`: <!--todo: needs to be done from ci to ensure regenration is done--> |
There was a problem hiding this comment.
Format the TODO comment and correct the typo.
- `yarn docusaurus gen-api-docs all`: <!--todo: needs to be done from ci to ensure regenration is done-->
+ `yarn docusaurus gen-api-docs all`: <!-- TODO: needs to be done from CI to ensure regeneration is done -->Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| `yarn docusaurus gen-api-docs all`: <!--todo: needs to be done from ci to ensure regenration is done--> | |
| `yarn docusaurus gen-api-docs all`: <!-- TODO: needs to be done from CI to ensure regeneration is done --> |
|
|
||
| ### Installation | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Specify a language for the fenced code block to enable syntax highlighting.
- ```
+ ```bash
$ yarn
- ```
+ ```bash|
|
||
| ### Local Development | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Specify a language for the fenced code block to enable syntax highlighting.
- ```
+ ```bash
$ yarn start
- ```
+ ```bash|
|
||
| ### Build | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Specify a language for the fenced code block to enable syntax highlighting.
- ```
+ ```bash
$ yarn build
- ```
+ ```bash
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (1)
yarn.lockis excluded by!**/*.lock
Files selected for processing (3)
- CODEOWNERS (1 hunks)
- docs/bridge/docusaurus.config.ts (1 hunks)
- docs/bridge/package.json (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- CODEOWNERS
- docs/bridge/docusaurus.config.ts
- docs/bridge/package.json
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (1)
yarn.lockis excluded by!**/*.lock
Files selected for processing (2)
- docs/bridge/package.json (1 hunks)
- package.json (2 hunks)
Files skipped from review as they are similar to previous changes (2)
- docs/bridge/package.json
- package.json
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- docs/bridge/package.json (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- docs/bridge/package.json
Description
Add docs
Summary by CodeRabbit
docs/bridgedirectory.package.jsonto include new scripts and dependencies for Docusaurus and TypeScript, ensuring better development practices and browser compatibility.