backstage / backstage/mkdocs-monorepo-plugin

Question on limitations - nested documentation projects

Open
#17 3 comments 0 reactions 0 assignees View on GitHub
wontfix
Dominant language
Python
Stars
400
Forks
80
PR merge metrics
No merged PRs in 30d

Description

Hello,

The documentation on Limitations states that "In an included mkdocs.yml, you cannot have !include. It is only supported in the root mkdocs.yml".

I would like to know if this is a design decision or a limitation that could be addressed in the future?

Contributor guide

Open the contributing guide

Research direction

Start by reading the Limitations documentation section describing !include in nested mkdocs.yml files and reviewing the surrounding issue discussion. Done would be a clear decision on whether nested documentation projects should support !include, with the required scope documented if work is pursued.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.