Skip to content

fix : restructure README,fix typos,and improve TOC#4

Open
mehrinshamim wants to merge 2 commits into
amjarmed:mainfrom
mehrinshamim:fix/readme-structure-and-typos
Open

fix : restructure README,fix typos,and improve TOC#4
mehrinshamim wants to merge 2 commits into
amjarmed:mainfrom
mehrinshamim:fix/readme-structure-and-typos

Conversation

@mehrinshamim

Copy link
Copy Markdown
  • Fix multiple typos (Quck, Ofical, duplicate "where")
  • Restructure TOC and remove emojis from headers for working anchor links
  • Group Core Concepts as subsections with proper hierarchy
  • Move Contacts under Official Documentation
  • Remove logo icons from all headings except Official Documentation

- Fix multiple typos (Quck, Ofical, duplicate "where")
- Restructure TOC and remove emojis from headers for working anchor links
- Group Core Concepts as subsections with proper hierarchy
- Move Contacts under Official Documentation
- Remove logo icons from all headings except Official Documentation
@mehrinshamim mehrinshamim changed the title fix: restructure README,fix typos,and improve TOC fix #4 : restructure README,fix typos,and improve TOC May 26, 2026
@mehrinshamim mehrinshamim changed the title fix #4 : restructure README,fix typos,and improve TOC fix : restructure README,fix typos,and improve TOC May 26, 2026
@mehrinshamim

Copy link
Copy Markdown
Author

This PR closes issue #3

Fixed broken TOC links and improved the README overall:

Issues Fixed

  • TOC anchor links - Emojis in headers were breaking navigation. Removed them so all links work now
  • Typos - Fixed Quck β†’ Quick, Ofical β†’ Official, Any type β†’ AnyType, duplicate "where", and table inconsistencies
  • Structure - restructured TOC, created proper Core Concepts grouping, moved Contacts under Official Documentation

Please check it out and let me know if anything needs adjusting. Otherwise, good to merge! πŸš€

Branch: fix/readme-structure-and-typos

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