Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

chore: contributing: add 'Useful links', rename FAQs & more #1714

Merged
merged 8 commits into from
Mar 1, 2023

Conversation

claremacrae
Copy link
Collaborator

@claremacrae claremacrae commented Mar 1, 2023

Description

  • Rename FAQs section to Code
  • Fix some broken section-level links
  • Update docs/README.md links to point to correct new location
  • Add a warning about the embedded code in Embedding code and data in documentation.md in case the browser isn't showing comments (Safari on iPhone does not, for me)
  • Added Useful Links page
  • Improved the formatting in 'How to read this documentation
  • Added "reveal-active-file-button" plugin

Motivation and Context

Just things I noticed that could be improved.

How has this been tested?

Viewing in Obsidian.

Screenshots (if appropriate)

Types of changes

Changes visible to users:

  • Documentation (prefix: docs - improvements to any documentation content)

Checklist

Terms

@claremacrae claremacrae added the scope: documentation Improvements or additions to documentation label Mar 1, 2023
@claremacrae claremacrae merged commit a35e997 into main Mar 1, 2023
@claremacrae claremacrae deleted the chore-improve-contributing-docs branch March 1, 2023 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant