Skip to content

Conversation

@rabail-aamir
Copy link
Contributor

Description

This PR restructures the Documentation/ directory and fixes outdated and broken internal links caused by legacy paths and folder moves.

Fixes # (issue)

Reorganised documentation into a clear, consistent structure:

  • Documentation/guides/
  • Documentation/reference/classes/
  • Documentation/research/
  • Documentation/contributing/

Updated outdated documentation links that referenced:

  • Removed Browser_IDE/ paths
  • Old commit-hash–based URLs
  • Legacy file locations

Standardised links to point to current paths on main, improving long-term stability.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as
    expected)
  • [ ✓] Documentation (update or new)

How Has This Been Tested?

  • Several documentation pages contained broken or misleading links after past refactors.
  • Using commit-hash URLs caused links to become stale over time.
  • This PR ensures documentation now points to current, authoritative sources, reducing confusion for contributors and maintainers

Testing Checklist

  • [✓ ] Tested in latest Chrome
  • [✓ ] Tested in latest Safari
  • [✓ ] Tested in latest Firefox

Checklist

  • [✓ ] My code follows the style guidelines of this project
  • [✓ ] I have performed a self-review of my own code
  • [ ✓] I have commented my code in hard-to-understand areas
  • [ ✓] I have made corresponding changes to the documentation
  • [✓ ] My changes generate no new warnings
  • [✓ ] I have requested a review from ... on the Pull Request

@liammcknightt
Copy link

liammcknightt commented Jan 7, 2026

First Peer Review:

The new folder structure containing documentation and guides is clear and structured, the internal links reflect the new structure and other updated references reflect correct structure.

Copy link

@Mdanial01 Mdanial01 left a comment

Choose a reason for hiding this comment

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

Overall, this is a well-scoped and well-structured pull request. The documentation reorganisation is clear, and keeping the changes focused on file moves and link fixes makes it easy to review and low-risk to merge. The new folder structure improves clarity and long-term maintainability of the docs.

Before merging, I recommend a quick clean-up of the duplicate _framework/ entry in .gitignore, verifying that all updated relative links resolve correctly in the rendered documentation, and checking that no hidden or bidirectional Unicode characters were accidentally introduced.

Once those small issues are addressed, this PR looks good to merge.

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.

3 participants