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: add permalinks #104

Merged
merged 1 commit into from
Aug 30, 2024
Merged

docs: add permalinks #104

merged 1 commit into from
Aug 30, 2024

Conversation

n0w0f
Copy link
Collaborator

@n0w0f n0w0f commented Aug 26, 2024

Screenshot 2024-08-26 at 14 18 27

allows creating link to sections within a page

Summary by Sourcery

Enable permalinks for section headers in the documentation by updating the mkdocs configuration.

Documentation:

  • Add permalinks to section headers in the documentation to enable easy linking to specific sections.

@n0w0f n0w0f requested a review from kjappelbaum August 26, 2024 12:20
Copy link
Contributor

sourcery-ai bot commented Aug 26, 2024

Reviewer's Guide by Sourcery

This pull request adds permalinks to the documentation by modifying the MkDocs configuration file. The change enables the creation of links to specific sections within a page, improving navigation and referencing capabilities.

File-Level Changes

Change Details Files
Added permalink functionality to the table of contents
  • Enabled the 'toc' extension in MkDocs configuration
  • Set the permalink symbol to a chain link emoji ('🔗')
mkdocs.yml

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @n0w0f - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@kjappelbaum kjappelbaum merged commit 24c04d9 into main Aug 30, 2024
1 of 2 checks passed
@kjappelbaum kjappelbaum deleted the permalinks branch August 30, 2024 12:29
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.

2 participants