cake-build / cake-build/website

Reduce number of reference categories

Open
#1,267 7 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
HTML
Stars
52
Forks
256
Avg merge
4h 42m
Merged PRs (30d)
8

Description

With the new reference page aliases are grouped by addin for every category. From a user perspective it would be more useful to have less categories, which group aliases from multiple addins and built-in, than categories for every addin (e.g. `EntityFramework` / `EntityFramework 6`, `Argument` / `Arguments`, etc). This would require PRs to the different addins and Cake itself to cleanup used categories.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the reference page's current alias grouping and the categories named in the issue, including EntityFramework, EntityFramework 6, Argument, and Arguments. Then identify where categories are defined across the Cake website, its addins, and Cake itself. Done means the reference page presents fewer user-oriented categories that combine built-in and addin aliases, with the required changes prepared across the affected projects.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.