Add <web-summary> tags to docs for search engine discoverability
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 1.1k
- Forks
- 83
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 30
Description
Analysing the documentation website with Bing webmaster yields:
The description is missing in the head section of the page. Search engines may use the description provided in the tag in the search engine results page (SERP). A well-written description that pertains to the content of the page and that is relevant to the searcher's intent can help you increase traffic since it can help improve the click-through rate of your page in search.
It looks like we can and should add a small description to each MarkDown file in the docs that will show up in search console results. The correct tag for this is <web-summary>
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
Start by locating the documentation website's Markdown files and checking how their metadata becomes the page head. Add an appropriate description to each relevant document, then verify that the rendered pages expose the descriptions for search engines.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100