oasisprotocol / oasisprotocol/docs
Document more Web3 gateway options
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
Rename "Running the Web3 gateway" section in https://github.com/oasisprotocol/docs/blob/main/docs/node/web3.mdx to "Configuration" so it's consistent with other Oasis node chapters. Then:
- Make "Archive Web3 gateway" a subsection.
- Move the
pruning-related settings out of the default config to a "Pruning" subsection. - Document other relevant Web3 gateway options in the corresponding subsections (be conscious about the default values and their context).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Update docs/node/web3.mdx, using the referenced oasis-web3-gateway/conf/config.go options as the source. First compare the section structure with other Oasis node chapters and review each option's default and context. Done means the page has a Configuration section, Archive Web3 gateway and Pruning subsections, and documents the relevant remaining gateway settings accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- blockchain, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100