Skip to content

♻️ TinaDocs | Remove ToC Coupling and use Hook Wrapper #3230

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

Closed
ssw-yakshaver bot opened this issue Apr 10, 2025 · 1 comment
Closed

♻️ TinaDocs | Remove ToC Coupling and use Hook Wrapper #3230

ssw-yakshaver bot opened this issue Apr 10, 2025 · 1 comment
Assignees

Comments

@ssw-yakshaver
Copy link

ssw-yakshaver bot commented Apr 10, 2025

Requested by: @isaaclombardssw via YakShaver.ai 🦬
cc: @isaaclombardssw, @amankumarrr, @JackDevAU, @Marxoz, @wicksipedia, @adamcogan

Hi Team!

  🟥  Watch the video (3 min 17 sec)

  

Pain

Refactor the Tina Docs implementation to remove repeated code, ensure consistent use of TinaCMS across pages, and improve the layout handling. This includes using the Tina client wrapper instead of TinaCMS hooks in individual components.

Acceptance Criteria

  1. Remove repeated code across Tina Docs pages.
  2. Ensure TinaCMS is used consistently across all relevant pages.
  3. Refactor layout handling to ensure the left-hand side table of contents is controlled by the layout and not re-rendered on reroute.
  4. Use Tina client wrapper instead of TinaCMS hooks in individual components.

Screenshot

Screenshot
Figure: Inconsistent use of TinaCMS across pages with similar documentation client basis.

@isaaclombardssw isaaclombardssw changed the title ✨ Refactor Tina Docs for Code Consistency and Improved Layout ♻️ TinaDocs | Big Refactor for Code Consistency and Improved Layout Apr 10, 2025
@isaaclombardssw isaaclombardssw changed the title ♻️ TinaDocs | Big Refactor for Code Consistency and Improved Layout ♻️ TinaDocs | Remove ToC Coupling and use Hook Wrapper Apr 10, 2025
@isaaclombardssw isaaclombardssw self-assigned this Apr 10, 2025
@isaaclombardssw
Copy link
Contributor

isaaclombardssw commented Apr 16, 2025

See tinacms/tina-docs#15 for specific changes.

Moved the table of contents component to the layout.tsx - so it's...

  1. Not Rerendered between docs pages
  2. Is abstracted away from the implementation of individual docs content pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant