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

Started modifying the User Manual page, and deleted the following sections: Updates for this Manual, Optimization, and Word of Warning. Added TOC (only first-level headings included, until I shorten most of the headings on the next iteration). Also, I created the Contribute to Nuitka page, but it’s not ready to see the world. To the Impressum page, I've added social media links from the User Manual. #70

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

marta-matvii
Copy link
Contributor

Started modifying the User Manual page, deleted the following sections: Updates for this Manual, Optimization, Word of Warning. Added TOC (only first-level headings included, until I shorten most of the headings on the next iteration). Also, I created the Contribute to Nuitka page, but it’s not ready to see the world.

Copy link

@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.

PR Type: Enhancement

PR Summary: This pull request focuses on enhancing the User Manual page by restructuring its content. It involves the removal of specific sections, namely 'Updates for this Manual', 'Optimization', and 'Word of Warning'. Additionally, a Table of Contents (TOC) has been introduced to improve navigation, currently including only first-level headings. The PR also mentions the creation of a 'Contribute to Nuitka' page, which is still under development, and the addition of social media links to the 'Impressum' page.

Decision: Comment

📝 Type: 'Enhancement' - not supported yet.
  • Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
📝 Complexity: the changes are too large or complex for Sourcery to approve.
  • Unsupported files: the diff contains files that Sourcery does not currently support during reviews.

General suggestions:

  • Given the changes are primarily to documentation and CSS styling, consider if there are any indirect impacts on the user experience that might warrant user testing or feedback.
  • For future iterations, when shortening headings or making further content adjustments, it might be beneficial to gather input from end-users or stakeholders to ensure the changes meet their needs and enhance clarity.
  • Since the 'Contribute to Nuitka' page is mentioned as not ready for public viewing, ensure that it is either not accessible from the live site or clearly marked as under construction to manage user expectations.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

…ogo (we accidentally deleted it with the home icon last time)
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