beefproject / beefproject/beef

Add references to command modules

Open
#2,286 2 comments 0 reactions 0 assignees View on GitHub
Code Quality
Dominant language
JavaScript
Stars
11k
Forks
2.4k
Avg merge
1d 1h
Merged PRs (30d)
15

Description

Often command module descriptions contain HTML (which kinda sucks).

This is occasionally used for formatting, which is fine.

There are many instances where the description only uses HTML to include links.

It would make much more sense to define a `references:` key in the module config YAML file to contain an array of reference URLs.

The admin UI should also be updated to display the reference URLs.

Contributor guide

Open the contributing guide

Research direction

Start by locating how command module YAML configuration is loaded and how descriptions are rendered in the admin UI. Add support for a references array of URLs in module configuration and display those URLs in the admin UI; done means link-only HTML descriptions can be represented through references and the links appear for administrators.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
full-stack
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.