MetaMask / MetaMask/docusaurus-openrpc

Changing the "label" name for the category to anything other than "Reference" in the sidebar.js results in failure to render the OpenRPC sidebar content.

Open
#71 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

team-wallet-api-platform
Dominant language
TypeScript
Stars
13
Forks
7
PR merge metrics
No merged PRs in 30d

Description

### Problem:

Following the instructions for instillation to integrate into an existing sidebar here: https://github.com/MetaMask/docusaurus-openrpc?tab=readme-ov-file#2-integrate-into-the-existing-sidebar

Changing the "label" name for the category to anything other than "Reference" in the sidebar.js results in failure to render the OpenRPC sidebar content. 

```
{
type: "category",
label: "Reference", // Changing this label
link: { type: "generated-index" },
items: [
{
type: "autogenerated",
dirName: "openrpc",
},
],
},
```

### Expected Behavior:

The label name for the sidebar category can be customized to a name other than "Reference."

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing-sidebar integration instructions in the README and the sidebar.js category shown in the report. Reproduce the failure by changing the category label from "Reference" while retaining the autogenerated openrpc directory. Done means the OpenRPC sidebar content renders with a customized category label.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.