oasisprotocol / oasisprotocol/docs
Can we make api.docs.oasis.io searchable?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
Instead of converting code/types into html docs, we could convert them to markdown (typedoc-plugin-markdown). But maybe this doesn't matter with many ai scraper options.
Or just tell users to search github
https://github.com/search?q=%28+org%3Aoasisprotocol+-repo%3Aoasisprotocol%2Fcometbft+-repo%3Aoasisprotocol%2Ftendermint+NOT+is%3Afork+%29++NOT+is%3Aarchived+NOT+path%3A**%2Fpackage-lock.json+NOT+path%3A**%2Fpnpm-lock.yaml+query&type=code
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
No files, tests, or entry points are named; start by inspecting how api.docs.oasis.io is generated and published. Compare the proposed typedoc-plugin-markdown approach with the linked GitHub code-search alternative, and define which searchable result or workflow would count as done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, markdown, typescript
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100