Closed JosePizarro3 closed 10 months ago
@JosePizarro3 I will see to add my review this evening, in case you need a 2nd one.
Hi @ndaelman-hu @JFRudzinski , thanks a lot for the effort in commenting on the changes. I will work on integrating the suggestions.
I'll keep it simple and resolve conversations when these are minor changes on the syntax, while commenting back when needed and leave the conversations open until they are fully resolved.
I will wait also for @ladinesa comments, as he is on sick leave, it will take a bit of time. But no problem, we just wait.
Hello again,
Thanks once more for the feedback. I think the page now reads much better. I will be happy if you can do another quick read (once more, there is no pressure or deadline for this, you can leave it for later next week) and see whether we missed something. I will keep working on the sections that are now "under construction" (with the exception of the Glossary).
Check out the new Contact section too.
I wanted to further comment: it will be nice if we can enforce certain style criteria using this section. This can be then transfer to other sections, so we can quickly work on them without caring about different styles. For example, titles of sections with "How-to ..." and "Explanation - ...", the fact that there might be always a "Overview" and a "References".
Hello @JFRudzinski @ndaelman-hu @ladinesa ,
Final round of reviews. The changes:
mkdocs serve
you could see which ones).Feel free to drop reviews whenever you feel it. Let's also keep the same organization (if possible) of "Overview", "How-tos", "Explanation - ..." and "References".
@ladinesa @ndaelman-hu @JFRudzinski thanks a lot for the help!
I think it might be a good idea to merge this. I added your feedback and suggestions, and I think we can move on into other sections and keep working in this documentation. After the feedback from Markus, I think this is a good idea, even if we end up deprecating this doc, most of what we are writing here will be probably saved into the general NOMAD doc.
Are you all OK with this? A simple approval or emoji would work for me to merge this.
Hi @ladinesa @ndaelman-hu @JFRudzinski
I've been working on the Uploading and Publishing section. The structure is the one in the document.
I have a few remarks:
I am still working on the documents, specially for the References and to add a phrase for each of the normalizers, but you can maybe take a look? I'd like comments on the content, as well as on the English, so feel free to take your time, there is no pressure to review this in the incoming days.
Once this is merged, we can start merging styles across sections, and come up with a global and yet very specific style for the whole documentation (for example, on how we cross-reference things).
Closes #8