Header doc link leads to clay-native, missing api doc index page
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 88/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- html
- Domain
- documentation
Research direction
Open content/_layouts/page.ejs around line 69 and compare the header link with content/api-docs/index.md and the published /api-docs/ page. Update the link so the API documentation index is reachable, then verify that the header opens the expected page and that the existing native-doc navigation remains unaffected.
Written by the indexing model from the issue text.
Description
Current link to api doc in site header leads to "native doc" section
https://github.com/ceramic-engine/ceramic-engine.github.io/blob/main/content/_layouts/page.ejs#L69
making this page https://ceramic-engine.com/api-docs/ | https://github.com/ceramic-engine/ceramic-engine.github.io/blob/main/content/api-docs/index.md "invisible".
Found this trying to get any info about web backend api, ending up searching on github. Search on the api page is scoped to backend, e.g. things related to web backend is not visible on native docs. This is expected but confusing when you dont know that you search the wrong section without any obvious way to open the right doc.
- Dominant language
- HTML
- Stars
- 0
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
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.
More from ceramic-engine/ceramic-engine.github.io
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
All issues in ceramic-engine/ceramic-engine.github.io
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100