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

Restructure documentation #19

Closed
ChristophB opened this issue Jun 23, 2023 · 0 comments · Fixed by #39
Closed

Restructure documentation #19

ChristophB opened this issue Jun 23, 2023 · 0 comments · Fixed by #39
Labels
documentation Improvements or additions to documentation

Comments

@ChristophB
Copy link
Member

ChristophB commented Jun 23, 2023

The content of README.md was taken from https://www.onto-med.de/ontologies/gfo and is not appropriate for a repository description.

Consider moving history, axiomatization and ontology documentation into separate files. We could use the GitHub wiki to provide a nice and user-friendly view on these files.

Also: add a short section "How to Use".

As a GFO consumer, I would also like to know on which parts (as in files or GFO in general) I can rely on and which obstacles I have to keep in mind.

Even better:

Provide comprehensive documentation with examples.

@ChristophB ChristophB added the documentation Improvements or additions to documentation label Jun 23, 2023
@ChristophB ChristophB linked a pull request Jul 9, 2024 that will close this issue
@ChristophB ChristophB removed a link to a pull request Jul 15, 2024
@ChristophB ChristophB linked a pull request Nov 25, 2024 that will close this issue
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

Successfully merging a pull request may close this issue.

1 participant