backstage / backstage/mkdocs-monorepo-plugin

Support `exclude_docs`

Open
#114 0 comments 2 reactions 0 assignees View on GitHub
awaiting contributor
Dominant language
Python
Stars
400
Forks
80
PR merge metrics
No merged PRs in 30d

Description

Since 1.5 mkdocs supports the new option [`exclude_docs`](https://www.mkdocs.org/user-guide/configuration/#exclude_docs)

This option is not reflected now by the Parser and the nav contains items for the non-existing files.

Contributor guide

Open the contributing guide

Research direction

Start by tracing the Parser's handling of MkDocs configuration and how it builds the nav. Verify the behavior with a configuration using exclude_docs, and consider the work done when excluded files no longer appear as navigation items.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
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.