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

Update (technical) documentation and move to WIKI #674

Open
1 task done
Carsopre opened this issue Jan 8, 2025 · 1 comment
Open
1 task done

Update (technical) documentation and move to WIKI #674

Carsopre opened this issue Jan 8, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation triage required Issues without priority assessment or milestone.

Comments

@Carsopre
Copy link
Collaborator

Carsopre commented Jan 8, 2025

Ra2ce version checks

  • I have checked that the issue still exists on the latest version of the docs in master here.

Kind of issue

Documentation is wrong

Location of the documentation

Documentation problem

  1. README.md does not include the link to the pypi release
  2. Our official documentation contains information that is non-relevant information for regular ra2ce users (non-developers or those who do not extend ra2ce functionality in any way). When this documentation requires changes of any type (including small typos) said changes need to go through the whole review process, potentially leading to conflicts on development branches with more relevant changes. Examples:
  3. The list of "Examples" seems to be getting out of hand.
    • Do we want to show ALL those examples to the users?
    • Or just a subset?
    • This directory is used by Binder, which seems to delay the start up of the environment.

Suggested fix for documentation

  1. Simply add the corresponding tag to the README file
  2. Move the following items into the WIKI pages, allowing for a faster and more dynamic way of maintaining this technical documentation (and more straightforwards as it is MARKDOWN instead of SPHINX formatting.
  3. Study whether it is possible to move Contributing into a separate tab to the main page similar as the ones of "Code of conduct" or "License".
  4. Discuss the options and added value for the Technical meetings section.
    • This one presents the challenge of only being jupyter notebooks, which we want to "persist".
    • Can we link / show the contents of these notebooks directly from a markdown document?
  5. Discuss the options and added value for the Technical documentation.
    • Should it be replaced by README.md files per src subproject?
    • Should we move it to the wiki?
    • Should we combine both of the above suggested options?
  6. Move ALL the examples to a separate (private) project only for Deltares contributors (including technical meetings from point 2 if they can't be in a wiki page).
    • Leave only in "examples" a very simple curated subset which avoids repetition of functionalities.
    • This implies updating TC so that said repository is picked up for testing.
    • The subset of curated examples should continued to be tested.
@Carsopre Carsopre added documentation Improvements or additions to documentation triage required Issues without priority assessment or milestone. labels Jan 8, 2025
@sahand-asgarpour
Copy link
Contributor

I proposed a selection of examples to remain in the Example folder. Crossed-out ones can be moved, in my opinion.

How the list is made:
I grouped the relevant ones by the drawn boxes and one multi-bracket like line (in black). Then, I filtered out the ones that describe a similar feature but use a different mode or method.

Image

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 triage required Issues without priority assessment or milestone.
Projects
None yet
Development

No branches or pull requests

2 participants