Skip to content

Document header ids #6196

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
samajammin opened this issue May 3, 2022 · 2 comments · Fixed by #12443
Closed

Document header ids #6196

samajammin opened this issue May 3, 2022 · 2 comments · Fixed by #12443
Assignees
Labels
documentation 📖 Change or add documentation feature ✨ This is enhancing something existing or creating something new

Comments

@samajammin
Copy link
Member

Is your feature request related to a problem? Please describe.

We don't have any documentation on how or why we use header ids in markdown files.

Describe the solution you'd like

Create a page in our GH docs explaining

  • why their important (consistent anchor links across languages, calculating translation status of pages)
  • how they're generated (i.e. manually or using the script)

Describe alternatives you've considered

None

Additional context

Some issues & PRs with historical context:

Want to contribute?

We love contributions from the Ethereum community! Please comment on an issue if you're interested in helping out with a PR.

@samajammin samajammin added feature ✨ This is enhancing something existing or creating something new documentation 📖 Change or add documentation labels May 3, 2022
@github-actions
Copy link
Contributor

This issue is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Jun 18, 2022
@corwintines corwintines removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label Feb 8, 2024
@corwintines
Copy link
Member

While the process has changed slightly with the migration to NextJS, we should still create this documentation. Going to remove stale and assign to @wackerow and @corwintines to get it done.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation 📖 Change or add documentation feature ✨ This is enhancing something existing or creating something new
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants