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 Update #29

Open
JGarciaCondado opened this issue Apr 10, 2024 · 0 comments
Open

Documentation Update #29

JGarciaCondado opened this issue Apr 10, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@JGarciaCondado
Copy link
Contributor

There has been a good initial effort to have proper documentation. However, we could benefit by making small changes.

ReadMe:

  • The background seems a bit too wordy and lengthy. Do we need the background? I do not think we need the motivation if we already have the background.
  • Are we calling them CLIs are they not commands. The description of the commands are very long. Do we really need to put that we have a .csv format in the readme? This should probably go to docs.
  • I would put the image at the top as the most clear visual indicator.
  • Why is the word Contribute in uppercase but Install isn't? Maybe just write the word Contribute instead of How to Contribute.
  • How to use should be after install. Order should be install, use, contribute, cite, license.

Contributing:

  • Should include contact information so people can reach out to us.
  • Should also link to the testing and code formatting docs when developed.

Naming: the namings in docs should be standardised as some are in capital letters others are not. Maybe change to MODELS and FILES, then TESTS and CODESTYLE

Tutorial:

  • Here is where there should be more information about the commands and what they do. The texts that are in the readme should come here.
  • A video should be filmed on how to use the more interactive CLI.
  • Also information on the figures produced and the file names produced. This have been updated.

Models:

  • We are missing information about scalers and feature extension.
@JGarciaCondado JGarciaCondado added the documentation Improvements or additions to documentation label Apr 10, 2024
@JGarciaCondado JGarciaCondado added this to the Release 1.0 milestone Apr 15, 2024
@itellaetxe itellaetxe self-assigned this Oct 16, 2024
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

When branches are created from issues, their pull requests are automatically linked.

2 participants