FAIRmat-NFDI / nyaml

https://fairmat-nfdi.github.io/nyaml
https://pypi.org/project/nyaml/
Apache License 2.0
1 stars 0 forks source link

README docs update. #31

Closed RubelMozumder closed 2 months ago

RubelMozumder commented 3 months ago

You can add the comments and suggestions for improvement.

lukaspie commented 3 months ago

Hi @RubelMozumder, @aalbino2 this was a great and careful "Aufschlag". I have started some editing and shuffling of content, see the copyFromPaperReviewMK branch. branch.

I think getting started has to come first, I started editing to make the paragraphs even more concise, maybe some of the material we should move to the nomad mkdocs because content like NeXus groups, fields, the keywords etc. reads to me more like a reference (it is great that this has been written) but it should come later in the readme. To the front the introduction should be even cleaner and more concise the guiding questions be: "Is this something relevant for me or for whom is this relevant? > What are benefits? > How can I get started i.e. use it with a simple example? Using the NXmpes example is good we should check again careful but I think that is about having most cases but is not yet too long. The workflow is useful but I would not place it as early in the README, may a crossref at the beginning.

Hi @mkuehbach, I think it is not necessarily a good idea to edit this draft across multiple branches because we will loose track eventually. Maybe a good idea is that you make a PR from your branch towards this branch so that we have a direct comparison and one your suggestions are in, the editing should continue in this branch. What do you think?