Conversation
|
@Theiaz, Love it so far, let me know when the descriptions are in. No issue with the headings; they're fine to include, but it's hard to tell without descriptions. Just tag me again when you want another look, and thanks again for contributing. |
3b53cb8 to
4310574
Compare
|
@AlexanderKaran The first version with a short description of all the patterns is ready for review. Not sure whiter we need to include all of them. I think with future iteration we can refine them. I also asked myself if it's better to provide the glossary content inside a markdown file instead of directly editing the html. What do you think? Also UX for the glossary can be improved by providing a ToC in a sidebar, but i think this should be another issue. |
There was a problem hiding this comment.
Pull request overview
This PR adds a glossary page to the Framework Tracker documentation site to clarify terminology around web application architectures (MPA/SPA) and rendering patterns (SSR, SSG, CSR, hydration techniques, etc.). This addresses issue #134 which identified confusion around these terms throughout the project. The PR also extracts a reusable BackLink component that was previously duplicated in FrameworkDetail.
Changes:
- Added a comprehensive glossary page covering application architectures and rendering patterns
- Extracted BackLink component to improve code reusability
- Updated FrameworkDetail component to use the new BackLink component
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| packages/docs/src/pages/glossary.astro | New glossary page with detailed definitions for MPA, SPA, SSR, SSG, CSR, hydration variants, ISR, PPR, streaming, RSC, and ESR |
| packages/docs/src/components/BackLink.astro | Extracted reusable back link component with consistent styling |
| packages/docs/src/components/FrameworkDetail.astro | Refactored to use the new BackLink component, removed duplicate styles |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Can you make this part of the PR? There have also been some changes to docs with a new header and we can add this Glossary in the Nav Bar if you merge in main :) Will read through the content today |
|
wording seems good to me! if anyone has feedback after we merge, we can always tweak it over time |
|
@Theiaz Content is great, if you can just make these tweaks we are good to go: #142 (comment) |
5a81f36 to
4e24896
Compare
4e24896 to
b196da9
Compare
Hey there, sorry for the delay. I already added the id to the h2 and h3 tags, should be enough (?). Or do you mean something else?
Nice one. I did some minor refactoring to align with the new changes and added the glossary to the navbar. Ready to merge 👍🏻 |
|
@Theiaz This is perfect, merged in. Going to share this later in the week its so good. Are you on BlueSky want to tag you |
Thanks. Yeah thats how I found this issue😄 |
First draft for the glossary page to resolve #134
TODOs:
Checklist
For backlink:
https://github.com/user-attachments/assets/9a7ecb4e-4ec4-4e68-b673-dce73a5e0532
starter-*package, ensure that the deps, and file content matches the output of the metaframeworks recommended starter/default project