IntelliTect / IntelliTect/CodingGuidelines

Allow for filtering coding guidelines by chapter

Open
#140 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
C#
Stars
12
Forks
16
Avg merge
2m
Merged PRs (30d)
7

Description

Objective: We want to allow for showing only coding guidelines that come from a particular chapter.

We believe the following needs to be done
- In the XML to Markdown converter wrap each guideline in a `span` with chapter number (extracted from key attribute in XML) with the chapter number as a css class.
- Inject a block of JavaScript and markup to allow for toggling the visibility of items with that class.

Contributor guide

Open the contributing guide

Research direction

Start at the XML-to-Markdown converter and inspect how each guideline's key attribute is parsed. The work is done when guidelines carry chapter-number CSS classes and the rendered output includes controls that toggle visibility by chapter; no specific file or test is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, javascript
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.