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

docs: use plugin names and refactor #2007

Merged
merged 1 commit into from
May 15, 2024
Merged

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented May 15, 2024

To improve the usability and maintainability of our documentation, we're making the following changes:

  • No longer using cleaned up names for plugins, instead we'll use the plugin ID as the title of the page, sidebar entry, and URL.
  • The svgo.dev repository is now responsible for injecting the headings for each plugin page. This cleans up our docs a lot, and improves maintainability. (There had been a few instances where the headings were added incorrectly, such as forgetting to include the parameters heading for a plugin with parameters.)
  • The implementation heading is being removed, and will now live in the TOC next to the "Edit this page on GitHub" link. This just looks a little cleaner.

Related

@SethFalco SethFalco merged commit 3bcdc37 into svg:main May 15, 2024
10 checks passed
@SethFalco SethFalco deleted the docs/refactor branch May 15, 2024 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant