backstage / backstage/mkdocs-monorepo-plugin

Submodules Should Allow for Overriding Plugin Options

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

Description

I have a use case where my monorepo contains a number of different projects, each being rendered using `mkdocstrings`. The owners of various projects want different configuration settings for `mkdocstrings` however this plugin only combines the `nav` section. I wanted to know if there was a way to allow it to merge the `plugins` as well? If not this could be a helpful feature.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the plugin's current submodule configuration handling and how the nav section is combined. Determine the intended precedence for project-level plugin options, then add coverage for the merge behavior and verify that different documentation projects can retain distinct mkdocstrings settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.