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

The Resource Panel #3

Open
babblebey opened this issue Dec 1, 2024 · 0 comments
Open

The Resource Panel #3

babblebey opened this issue Dec 1, 2024 · 0 comments

Comments

@babblebey
Copy link
Member

  • Implementation PR:

Summary

Introduce a Resource Panel under the word meaning in the dictionary entries on jargons.dev. This panel will provide users with links to external articles, videos, and other learning resources related to the word. The feature will also extend the jargons editor to collect and manage these resource links for each word.

Motivation

The primary goal of jargons.dev is to simplify software engineering terms and make them accessible to developers of all levels. By adding a Resource Panel, we can enhance the user experience and provide opportunities for deeper learning. Many developers look for practical guides, detailed explanations, or video tutorials to understand complex terms, and this panel will serve as a bridge to external resources, ensuring jargons.dev stays relevant and useful.

Goal

  1. Frontend Changes:
    • Add a Resource Panel below the word meaning on the word detail pages.
    • The panel should display a list of external resource links, categorized if necessary (e.g., Articles, Videos).
  2. Jargons Editor Update:
    • Add a new section in the editor interface to allow contributors to add, edit, or delete external resource links for words.
    • Implement input validation for URL formats and categorization.
  3. Content Updates:
    • Start collecting and curating external resources for a few popular words as an initial dataset.
  4. User Interface Consideration:
    • Ensure the Resource Panel is unobtrusive, visually aligned with the existing design, and easily navigable.
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

No branches or pull requests

1 participant