typst / typst/typst

Make language keywords searchable in docs

Open Beginner friendly
#8,433 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Rust
Stars
56.1k
Forks
1.7k
Avg merge
3d 10h
Merged PRs (30d)
22

Description

Description

Make the language keywords (like return, for, show) searchable in the documentation, by adding them as keywords to the relevant pages.

Rust even has documentation pages for individual keywords (e.g., return).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation pages for language keywords such as return, for, and show, then inspect how searchable keywords are currently declared on comparable pages. Add the keywords to the relevant pages and verify that searches for each keyword return those pages, including the individual keyword-page pattern noted for Rust.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.