canonical / canonical/robotics_documentation

Extend toctree to avoid duplication of links in the section landing pages

Open
#45 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
1
Forks
5
Avg merge
14d 23h
Merged PRs (30d)
1

Description

The TocTree render is currently limited to a list of links.

In order to have a render with maybe a small introduction, the list of links must be duplicated.

Extending toctree to be able to have a nicer render would avoid link duplication and simplify maintenance.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the TocTree render and the section landing pages that currently duplicate their links. Read how the existing list-only render is assembled and determine how an introduction should be represented. Done means landing pages can include a small introduction without duplicating the toctree links, with the documentation render verifying the result.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.