backstage / backstage/mkdocs-monorepo-plugin

Allowing mkdocs-monorepo.yml to integrate existing mkdocs site without breaking configuration

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

Description

Thank you for making this useful tool. I have one suggestion.

I can't seem to be able to use any file name other than mkdocs.yml. Can you allow the existing site to use the mkdocs.yml file, and use a different configuration file when connecting to monorepo?

This will allow for a more various configuration and will be useful.

Contributor guide

Open the contributing guide

Research direction

Locate the configuration-loading entry point and trace how mkdocs.yml and mkdocs-monorepo.yml are handled. Confirm how an existing site can retain mkdocs.yml while the monorepo integration uses a separate configuration file, without breaking either configuration.

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.