Skip to content

[BUG] "Edit this page" from the rendered docs is not helpful for RPC API section. #2588

@IkerAlus

Description

@IkerAlus

Description

Due to the structure of the doc pages in the RPC API section, a user wants to submit a change directly from the webpage, with the "Edit this page" clickable at the end of the page, won't be able to do it.

Steps to reproduce:

  1. Go to any of the RPC API doc pages, for example: https://docs.near.org/api/rpc/block-chunk
  2. Click on "Edit this page" clickable at the end of the page.
  3. A new tab will open at https://github.com/near/docs/edit/master/docs/api/rpc/block-chunk.md . As you can see, most of the info at this page is imported from "@site/src/components/docs/api/" so the user can't really edit much.

Page URL

https://docs.near.org/api/rpc/introduction

Impact

  • Incorrect information
  • Missing information
  • Unclear explanation
  • Broken link
  • Code example doesn't work
  • Other (please specify in description)

Suggested Fix

Follow the same doc structure as in the other doc sections so that all the information is contained in the same md file and not imported from other folders.

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

Status

Shipped 🚀

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions