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

Documentation for pid4cat service (not just for the model) #96

Open
dalito opened this issue Mar 25, 2025 · 1 comment
Open

Documentation for pid4cat service (not just for the model) #96

dalito opened this issue Mar 25, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@dalito
Copy link
Member

dalito commented Mar 25, 2025

The current mkdocs based documentation should be extended to cover not only the linkml metadata model but all aspects of pid4cat (model, APIs, python package, best practice guides etc.).

@dalito dalito added the documentation Improvements or additions to documentation label Mar 25, 2025
@dalito dalito changed the title Documentation for pid4cat (not just the model) Documentation for pid4cat service (not just for the model) Mar 25, 2025
@dalito
Copy link
Member Author

dalito commented Mar 25, 2025

#97 significantly extends the documentation to cover most aspects of the pid4cat service. However, some parts are still in early draft state.

Before closing this issue the results of a currently ongoing documentation review (in google docs) should be evaluated and used to prepare a second PR with improvements.

The extended docs based on #97 are already deployed as "dev" version. See here https://nfdi4cat.github.io/pid4cat-model/dev/

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

1 participant