Skip to content

Reorganize reference section - #39

Merged
scott-klaytn merged 3 commits into
kaiachain:mainfrom
scott-klaytn:reorganize-reference-section
Jul 9, 2024
Merged

Reorganize reference section#39
scott-klaytn merged 3 commits into
kaiachain:mainfrom
scott-klaytn:reorganize-reference-section

Conversation

@scott-klaytn

Copy link
Copy Markdown
Contributor

Proposed changes

  • Move the Public JSON RPC Endpoints entry to the top of Reference sidebar
  • Merge RPC Endpoints and RPC Provider into a single page with the removal of service provider folder
  • Move the Transaction error page under sdk category because Txerror is related to caver SDK
  • Add shortcut to the Public JSON RPC Endpoints in common sidebar
    image

Types of changes

Please put an x in the boxes related to your change.

  • Minor Issues and Typos
  • Major Content Contribution
  • Others

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to reach out. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING GUIDELINES
  • I have read the CLA and signed by comment I have read the CLA Document and I hereby sign the CLA in first time contribute
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Related issues

Further comments

Comment thread docs/references/public-en.md Outdated

|Service Provider|Endpoints|Namespaces|Type|
|---|---|---|---|
|[Kaia Foundation](https://www.klaytn.foundation)|`https://public-en-baobab.klaytn.net`|klay,eth,net|Full|

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.

Hi @scott-klaytn , can we also please consider adding kairos endpoint here along with others ?
https://public-en.kairos.node.kaia.io
Reference: https://klaytn.foundation/kaia-testnet-kairos-launch/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've replaced the old testnet endpoint with the new one. For others, I will update them as new urls are made available practically. @praveen-klaytn

@ayo-klaytn

ayo-klaytn commented Jul 8, 2024

Copy link
Copy Markdown
Contributor

Move the Transaction error page under sdk category because Txerror is related to caver SDK

Hi @scott-klaytn, can we leave TxError page as is? or better still add to the common sidebar?

imo, It would fit the new position only if it list the possible errors emitted when using caver.js or any of the libraries. In this case, its just the general tx error code when deploying, interacting with a contract or using any of the libraries on Kaia.

Do lemme know your thoughts. Thanks.

@scott-klaytn

Copy link
Copy Markdown
Contributor Author

Hi @scott-klaytn, can we leave TxError page as is? or better still add to the common sidebar?

imo, It would fit the new position only if it list the possible errors emitted when using caver.js or any of the libraries. In this case, its just the general tx error code when deploying, interacting with a contract or using any of the libraries on Kaia.

Do lemme know your thoughts. Thanks.

Hi, @ayo-klaytn Right, You have a point. It's my oversight because I saw the links to Transaction Error Code page in SDK pages only. But it's more general information as you mentioned. Where can we find appropriate place for this? For common sidebar, I want to reserve this area for the information only that doesn't fall into any of main category, or, at least, for quite frequently visited pages that need to stand out. (I have to if there is no better choice, though.)

How about revert it to its original position with the different order? That is, the root of Reference section and at the bottom.

@scott-klaytn

Copy link
Copy Markdown
Contributor Author

I've moved the error code page to the root of Reference section and made it located in the bottom. @ayo-klaytn

@scott-klaytn
scott-klaytn merged commit ba4e610 into kaiachain:main Jul 9, 2024
@scott-klaytn
scott-klaytn deleted the reorganize-reference-section branch July 9, 2024 05:43
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 9, 2024
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