Skip to content

Add glossary page#142

Merged
AlexanderKaran merged 9 commits intoe18e:mainfrom
Theiaz:glossary-page
Feb 23, 2026
Merged

Add glossary page#142
AlexanderKaran merged 9 commits intoe18e:mainfrom
Theiaz:glossary-page

Conversation

@Theiaz
Copy link
Contributor

@Theiaz Theiaz commented Feb 20, 2026

First draft for the glossary page to resolve #134

TODOs:

  • Add a (short) description for each of the terms
  • Check wheter to use Markdown with a generator instead of plain HTML
  • Add Table of content as sidebar --> new issue
  • Make headings selectable anchors --> new issue

Checklist

  • If updating UI/UX components ensure you have added screenshots or a gif or video of the changes to the PR description
    For backlink:
    https://github.com/user-attachments/assets/9a7ecb4e-4ec4-4e68-b673-dce73a5e0532
  • If this is a dependabot PR that bumps a metaframework version, ensure that all package versions in the package match the versions installed by the metaframework version being bumped
  • If this is a dependabot PR that bumps a metaframework version in a starter-* package, ensure that the deps, and file content matches the output of the metaframeworks recommended starter/default project

@AlexanderKaran
Copy link
Collaborator

@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.

@Theiaz Theiaz force-pushed the glossary-page branch 6 times, most recently from 3b53cb8 to 4310574 Compare February 20, 2026 12:32
@Theiaz
Copy link
Contributor Author

Theiaz commented Feb 20, 2026

@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.

@Theiaz Theiaz marked this pull request as ready for review February 20, 2026 13:32
@Theiaz Theiaz requested a review from 43081j as a code owner February 20, 2026 13:32
Copilot AI review requested due to automatic review settings February 20, 2026 13:32
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@AlexanderKaran
Copy link
Collaborator

AlexanderKaran commented Feb 22, 2026

@Theiaz

Can you make this part of the PR? Make headings selectable anchors --> new issue, just put an id in their headers

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

@43081j
Copy link
Contributor

43081j commented Feb 22, 2026

wording seems good to me!

if anyone has feedback after we merge, we can always tweak it over time

@AlexanderKaran
Copy link
Collaborator

@Theiaz Content is great, if you can just make these tweaks we are good to go: #142 (comment)

@Theiaz
Copy link
Contributor Author

Theiaz commented Feb 23, 2026

Can you make this part of the PR? Make headings selectable anchors --> new issue, just put an id in their headers

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?

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 :)

Nice one. I did some minor refactoring to align with the new changes and added the glossary to the navbar.

Ready to merge 👍🏻

@AlexanderKaran AlexanderKaran merged commit 0fb46dc into e18e:main Feb 23, 2026
1 check passed
@AlexanderKaran
Copy link
Collaborator

@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

@Theiaz
Copy link
Contributor Author

Theiaz commented Feb 24, 2026

@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😄
https://bsky.app/profile/jschaeferdev.bsky.social

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.

Index, Glossary, Terms Page

4 participants