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

Missing points in documentation #8

Open
6 tasks
Pfeil opened this issue Jun 21, 2022 · 0 comments
Open
6 tasks

Missing points in documentation #8

Pfeil opened this issue Jun 21, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Pfeil
Copy link
Member

Pfeil commented Jun 21, 2022

The API is documented by examples and javadocs (the non-trivial-parts at least) and is pretty straight forward. But there is space for improvements, as far as I can see:

Developer docs

Parts of this are also interesting for users:

  • How is import different from export, which class members store what in which case?
  • How are invalid crates being handled on import? What is being tolerated (with warnings), what kind of invalid crates can we not import?
  • When exactly are which parts being validated against what?
  • We need a contribution.md which explains also the principles to ensure contributions are consistent (e.g., what to consider in builders etc)
  • we need a release process to be documented and possibly tooling for it. Somesy can be used to keep the citation.cff up-to-date with another file, but gradle.properties is not yet supported. We can either use some script to invoke instead of gradle release with all required syncing boilerplate, and possibly contribute to somesy.

User docs

@Pfeil Pfeil added the documentation Improvements or additions to documentation label Jun 21, 2022
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