Skip to content
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

glossary module #65

Open
2 of 3 tasks
devinschumacher opened this issue Jun 2, 2024 · 2 comments
Open
2 of 3 tasks

glossary module #65

devinschumacher opened this issue Jun 2, 2024 · 2 comments
Labels
feature 🎁 New feature or request to improve something glossary module
Milestone

Comments

@devinschumacher
Copy link
Member

devinschumacher commented Jun 2, 2024

TODO

  • glossary index
  • glossary single
  • auto-interlinking

The glossary "module" is an easy way to pick up "information intent" traffic to your website, and backlinks when you start ranking.

It's basically a giant dictionary of the all 'terminology' in your industry.

Default URL structure

  • index: site.com/glossary/
  • single: site.com/glossary/<slug>/

Design references

  • index + a search bar ideally
  • single (without the weird skinny thing on the right bc that looks like shit)

Functionality

Auto-interlinking

The glossary should automatically interlink all of the all terms in your glossary together on each single page (like how wikipedia does it).

For example, if you had glossary pages for the terms:

  • credit card
  • debit card
  • interest rates

And the post about "interest rates" mentioned the keyword credit card it should automatically link to the credit card page.

Having these interlinks automatically generated will significantly increase the crawling, link-power & SEO. It's also a nice experience for the user.

BONUS: Even better if the terms had tooltips on hover that showed the 'one_liner` (aka short definition) of each. But that's a bonus feature. Does not need to be included in MVP if it's non-trivial.

@devinschumacher devinschumacher added feature 🎁 New feature or request to improve something module glossary labels Jun 2, 2024
@devinschumacher devinschumacher added this to the v0.0.1 milestone Jun 2, 2024
@niallquirke
Copy link
Contributor

You can't auto-link from the web app. The only way I can think of automating this is to run a script iterating through the words in the glossary posts, querying the db for every word + every 2 words in a row + every 3 words in a row and if it finds a match it replaces the term with a markdown link to /glossary/[term] which is obviously a pretty heavy and error prone script but it's the best I can think of and it's worth a shot. I presume this is usually done manually, like wikipedia.

@devinschumacher
Copy link
Member Author

@niallquirke okay no problem ill bump this feat to another iteration and me and @francislabountyjr will do it

@devinschumacher devinschumacher modified the milestones: v0.0.1, v ++ Jun 23, 2024
@devinschumacher devinschumacher removed their assignment Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature 🎁 New feature or request to improve something glossary module
Projects
None yet
Development

No branches or pull requests

2 participants