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

Replace documentation in packages' READMEs with the link to the doc at allurereport.org #893

Closed
delatrie opened this issue Feb 29, 2024 · 1 comment

Comments

@delatrie
Copy link
Collaborator

From #815 (comment):

Currently, each package's README contains documentation that describes how to use the package. It overlaps with the corresponding documentation pages at allurereport.org.

We should shorten the documentation part to a simple instruction on how to start using the package. The rest should be replaced with the link to the appropriate page on the website. That would reduce duplication and prevent stalled docs and examples in README files.

@delatrie delatrie mentioned this issue Feb 29, 2024
2 tasks
@baev
Copy link
Member

baev commented May 31, 2024

done

@baev baev closed this as completed May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants