[docs-infra] Improve docs API SEO
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
From https://github.com/mui/material-ui/pull/40396
I wonder if it would make sense to format more the HTML of the API pages, with h4, h3 so Google can more easily return relevant search results.
I have tried searching for the description of props on Google, can't really find helpful results. Maybe it's not a common workflow though, I don't recall ever trying this in the past as a user.
Search keywords:
Contributor guide
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
Review the context in PR #40396 and inspect the generated HTML for the API pages. Determine which API content should use h3 or h4 headings and how success would be measured through improved search results; the issue does not name implementation files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100