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

Add Navigation Links to "Answers to a Few Questions" Section #624

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

vidipsingh
Copy link
Contributor

@vidipsingh vidipsingh commented Dec 30, 2024

This pull request enhances the project documentation by adding direct links to the "Answers to few questions" section in the README. The goal is to improve navigation and accessibility, allowing users to easily find answers to common questions and follow necessary steps.

Changes Made:

  • Added clickable links that navigate directly to the "Answers to few questions" section in the README.
  • Improved the overall structure and readability of the documentation to provide a more user-friendly experience.

Issue Link:

Closes #430

How to Test:

  1. Open the README file.
  2. Verify that the new links correctly take you to the "Answers to few questions" section.
  3. Ensure that the links function as expected and provide a smoother navigation flow.

Additional Notes:

This update enhances the documentation by offering quick access to frequently asked questions, helping users find relevant information faster and improving the overall usability of the project’s documentation.

Copy link
Contributor

@saumyashahi saumyashahi left a comment

Choose a reason for hiding this comment

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

The commit message is too lengthy, you should go through this https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md#making-commits and change the commit accordingly.

@quozl
Copy link
Contributor

quozl commented Dec 31, 2024

You've misunderstood the issue, as it was vague and hadn't reached a clear consensus. I've summarised the consensus and updated the issue. Please adjust your change accordingly.

- Fixes sugarlabs#430
- Improves navigation within the documentation to help users find common answers easily.
@vidipsingh vidipsingh force-pushed the fix/add-links-answers-section-430 branch from 1841c3c to 6d288f3 Compare December 31, 2024 09:09
@vidipsingh vidipsingh changed the title Add Navigation Links to "Answers to Few Questions" Section Add Navigation Links to "Answers to a Few Questions" Section Dec 31, 2024
- Fix sugarlabs#430
- Changed "Answers to Few Questions" to "Answers to a Few Questions" in the README and updated all related section links.
@quozl
Copy link
Contributor

quozl commented Dec 31, 2024

Thanks for your updates.

- Fixes commit #04250a2
- This update changes all internal links to use relative anchor links with the correct GitHub Markdown format to ensure proper navigation within the document.
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.

Question about "Answers to a few questions" referenced in README
3 participants