ampproject / ampproject/amphtml

Documentation – Typos / outdated information

Open
#40,428 3 comments 0 reactions 0 assignees View on GitHub
Type: Bug
Dominant language
JavaScript
Stars
14.9k
Forks
4.1k
PR merge metrics
No merged PRs in 30d

Description

### Description

Project’s documentation page notes: “If you see out of date, misplaced, or incorrect information, you can fix it! We welcome fixes as pull requests, but are equally appreciative if you file an issue.”
AMP
+1
This is a helpful starter issue: you can browse through the docs, find any small errors (typos, outdated links, minor inconsistencies), then raise an issue that describes what needs fixing (or fix it directly via a PR).
This type of issue is recommended by the project for newcomers:
“If you’d like to contribute but are unsure of where to start, check our issues and filter by the good first issues label. These are easy fixes that will get you familiar with amp.dev and how the contributing process works.

### Reproduction Steps

Fork the repo: https://github.com/ampproject/amphtml and set up locally (per README).
[GitHub](https://github.com/ampproject/amphtml?utm_source=chatgpt.com)
Browse the documentation (on the docs folder or relevant *.md in repo) and look for:
Typographical errors (spelling/grammar)
Out-of-date links
Incorrect or unclear instructions
Examples that don’t match latest code behaviour
Once you find something:
Raise an Issue on GitHub: title it clearly (e.g. “Typo in docs/… – ‘teh’ → ‘the’”), describe location, what’s wrong, and how to reproduce.
Optionally, assign yourself (if the project allows) and/or proceed to fix it and submit a Pull Request (PR).
In the PR: reference the issue, describe what you changed, verify formatting/build if needed.
After submission: monitor for maintainer feedback, be ready to adjust per review.

### Relevant Logs

```shell

```

### Browser(s) Affected

_No response_

### OS(s) Affected

_No response_

### Device(s) Affected

_No response_

### AMP Version Affected

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the repository README setup instructions, then browse the docs folder and relevant *.md files for a specific typo, outdated link, unclear instruction, or example mismatch. Done means recording the exact location and correction, then verifying formatting or the documentation build if needed before opening an issue or pull request.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.