jargonsdev / jargonsdev/roadmap
The Resource Panel
- Dominant language
- No language data
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
- 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.
Contributor guide
No contributing guide indexed for this repository
Research direction
No files, tests, or implementation entry points are named. Start by clarifying the word detail page, editor, resource data model, validation rules, categorization, and initial dataset; done means the panel displays resources and contributors can add, edit, and delete validated links.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100