korlibs / korlibs/docs.korge.org

Single-column collapsible table of contents

Open
#33 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
CSS
Stars
3
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Right now table of contents is divided into 4 columns and it's hard to read and understand. If we just make it single-column, it will take a lot of space on some pages. So maybe we could also make it collapsible?

I tried to use Bootstrap's Collapse template, but I couldn't get table of contents generated inside it for some reason (maybe I missed something).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating how the documentation site's table of contents is generated and review the attempted Bootstrap Collapse integration described in the issue. The work is done when the table of contents displays in one column and can be collapsed without making pages unnecessarily tall.

Written by the indexing model from the issue text.

Assessment

Tech stack
bootstrap, css
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.