Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow to configure common readmeFile when creating documentation from monorepo #2065

Closed
Hi-Fi opened this issue Sep 29, 2022 · 1 comment
Closed

Allow to configure common readmeFile when creating documentation from monorepo #2065

Hi-Fi opened this issue Sep 29, 2022 · 1 comment
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@Hi-Fi
Copy link

Hi-Fi commented Sep 29, 2022

Search Terms

readmeFile, documentation, README, packages, monorepo

Problem

Currently documentation from module's main page in monorepo documetantion is left out unless explicitly defined in package.json with readmeFile. This feels a bit ugly solution, as readme file is quite often README.md (or anyway same in all modules inside monorepo.

Suggested Solution

I think it would be nice to have either

  • Automatic usage of README.md (maybe case insensitive way) from module directory; or
  • Common flag to set file name, which is then used from each module's directory
@Hi-Fi Hi-Fi added the enhancement Improved functionality label Sep 29, 2022
@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Sep 29, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 29, 2022

I don't love flags if there's a reasonable default - I like the idea of grabbing the readme.

@mokone91 mokone91 mentioned this issue Oct 26, 2022
Closed
GerkinDev added a commit to KnodesCommunity/typedoc-plugins that referenced this issue Apr 5, 2023
@GerkinDev
chore(plugin-monorepo-readmes): remove plugin
cb7161b 
Deprecated since typedoc@>=0.23.16, see TypeStrong/typedoc#2065
GerkinDev added a commit to KnodesCommunity/typedoc-plugins that referenced this issue Apr 5, 2023
@GerkinDev
chore(plugin-monorepo-readmes): remove plugin
9c64177 
Deprecated since typedoc@>=0.23.16, see TypeStrong/typedoc#2065
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Hi-Fi @Gerrit0