arkmq-org / arkmq-org/markdown-runner

Tutorials: prefix the title with a Category

Open
#20 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Right now the tutorials are sorted in alphabetical order. This isn't ideal because as we can't easily group by topics related tutorials. To address this, let's prefix the titles with a Category to group them together, for instance:

* `Deployment: Deploying the Basic Broker Image`
* `Deployment: Using the custom init image`
* `Encryption: Setting up SSL connections with ArtemisCloud Operator`
* `Encryption: Setting up SSL with cert-manager and trust-manager`

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the tutorial documents and reviewing how their titles are defined and sorted. Group related tutorials by adding category prefixes such as Deployment and Encryption, then verify that the resulting titles sort into the intended groups.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.