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.

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

Use dedicated README files for individual packages #564

Open
and-hus opened this issue Sep 23, 2024 · 1 comment
Open

Use dedicated README files for individual packages #564

and-hus opened this issue Sep 23, 2024 · 1 comment
Labels
Documentation Improvements or additions to documentation

Comments

@and-hus
Copy link
Contributor

and-hus commented Sep 23, 2024

Is your feature request related to a problem? Please describe.
The repository contains a global README.md file, which nicely introduces the complete SDK and provides some generic information and links. Currently all assets/packages from the repository are configured to use this README.md file when packaging. This means, that this very generic README is also shown e.g. on nuget.org for each package (see e.g. HL7.Cql.Packaging).

I would propose to use dedicated README.md files for each package.
This allows to provide more detailed and more specific documentation and information for the respective package.

Describe the solution you'd like
I would propose to use dedicated README.md files for each package.
This allows to provide more detailed and more specific documentation and information for the respective package.

I have prepared a small PR, providing an example for such a dedicated README.md file for the PackagerCli project, which builds into the HL7.Cql.Packaging nuget package: #563

Describe alternatives you've considered
none (basically leave it as it is)

Additional context
none

@baseTwo baseTwo added the Documentation Improvements or additions to documentation label Sep 23, 2024
@baseTwo
Copy link
Collaborator

baseTwo commented Sep 23, 2024

Related issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants