Skip to content

[DOCS]: Add cross-navigation section between README, QUICKSTART, FAQ and RESOURCES #52

@MsParadox

Description

@MsParadox

Current Documentation Issue

The repository has multiple useful documentation files, but the navigation between them is not very clear. New contributors may read one file and not easily find the others, especially FAQ.md and RESOURCES.md.

This makes onboarding slower and can lead to repeated questions or missed information.

Suggested Improvement

Add a small "Related Documentation" or "Documentation Hub" section to the main documentation files so contributors can easily move between:

  • README.md
  • QUICKSTART.md
  • CONTRIBUTING.md
  • FAQ.md
  • RESOURCES.md

This can be done with a simple link section near the top or bottom of each file.

Additional Context

This is a documentation-only improvement and does not affect code behavior.

It would improve discoverability, reduce confusion for new contributors, and make the project feel more organized for first-time visitors.

Metadata

Metadata

Assignees

Labels

No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions