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(docs): bumped mkdocs-material to latest + small tweaks #1217

Merged
merged 1 commit into from
Jan 7, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR bumps the version of mkdocs-material to 9.0.2 (from 8.5.9) and introduces a handful minor tweaks to the docs:

  • Consolidate primary & accent colors to deep orange in both light & dark themes
  • Add option to dismiss announcements / banners
  • Add icon links for repo & Discord Server in site footer

How to verify this change

See published version after merge.

Related issues, RFCs

Issue number: #1216

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi self-assigned this Jan 7, 2023
@pull-request-size pull-request-size bot added the size/S PR between 10-29 LOC label Jan 7, 2023
@dreamorosi dreamorosi merged commit d8e8d38 into main Jan 7, 2023
@dreamorosi dreamorosi deleted the chore/mkdocs/bump branch January 7, 2023 16:09
@github-actions github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Jan 7, 2023
@dreamorosi dreamorosi linked an issue Jan 7, 2023 that may be closed by this pull request
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/S PR between 10-29 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: Update docs engine to latest
1 participant