aiida-core icon indicating copy to clipboard operation
aiida-core copied to clipboard

Docs: Update documentation for 2.7

Open khsrali opened this issue 8 months ago • 5 comments

Our RTD: https://aiida.readthedocs.io/projects/aiida-core/en/stable/ Only updates by each aiida-core releases.. Therefore before each release, we may update our documentation according to the merged PRs

khsrali avatar Apr 25 '25 12:04 khsrali

@khsrali This is very unspecific. One can go through all documentation issues buy filter for the documentation label. But then it is overwhelming. So please specify here doc issues that should be fixed by the next release, otherwise I think this issue can be closed as it serves no purpose.

agoscinski avatar May 02 '25 20:05 agoscinski

Mainly

  • [x] Stashing -> @khsrali -> #6861
  • [x] Dumping -> @GeigerJ2
  • [ ] ~Installing dependencies using uv? -> @danielhollas see this comment from a contributor~ Moved to https://github.com/aiidateam/aiida-core/issues/6801
  • [x] ForceKill -> @agoscinski #6909

khsrali avatar May 03 '25 12:05 khsrali

@agoscinski Why is this 2.8 ? I believe should be 2.7.1 or 2.7.2? We should document how to use what we release 😄

khsrali avatar May 06 '25 15:05 khsrali

Installing dependencies using uv? -> @danielhollas see https://github.com/aiidateam/aiida-core/pull/6847#issuecomment-2845529426 from a contributor

I don't see this in the RTD. I would separate issues into Wiki updates which we can immediately update and doc updates which only only keep updated with a release. I move it somewhere else

ForceKill -> @agoscinski

I don't think we need RTD for force kill. It is a CLI command and is explained in the help page there. EDIT: Little did I know, that there is verdi process {play|pause|kill} is in the RTD, I made a PR for updating it.

agoscinski avatar Jun 06 '25 11:06 agoscinski

Yeah, uv stuff is more for developers not users. Note that we've been discussing moving at least part of the wiki into internal docs in the repo itself, since it is then much easier to keep up to date. I can handle the uv part once I have a bit more time, probably by the and of June.

danielhollas avatar Jun 06 '25 11:06 danielhollas

🤔

khsrali avatar Oct 15 '25 06:10 khsrali

Assignee was missing in the column of the 2.7.2 project, and it triggered my OCD ^^

GeigerJ2 avatar Oct 15 '25 08:10 GeigerJ2

😆 all good!

khsrali avatar Oct 15 '25 14:10 khsrali