For Arches v4, documentation will be handled in three different locations,
in order to address the needs of different types of Arches users.
1. In-app Help, as reference material for those using the app interface.
Many pages within the app itself will have a ? button in the
top-right corner of the page. This is context specific content, so if you
are using the graph designer, you will find information about the graph
designer.
2. Full User Documentation, hosted on read the docs:
https://arches4.readthedocs.io/en/latest/
This documentation will include all of the content described above,
as well as extra information for all of the Arches user interface.
3. Developer Documentation, in the Arches github repo:
https://github.com/archesproject/arches/wiki
Geared toward more technical users, this documentation will (and
already does) contain a lot of nuts and bolts about how to install and
customize Arches, as well as a more in-depth look at how it's constructed.
Like the software, the documentation is not yet complete, so apologies in
advance for sections that are partial. Know that more is coming as the
development effort continues... Also, the Arches project website will soon
be updated to point to these documentation locations.
Please respond to this thread with any suggestions or feedback on what you
see. Documentation issues can also be tracked in github, just use the
Documentation label when creating the ticket.
Thanks!
Adam
p.s. It was great to meet all of you who were able to attend the workshop
in Liverpool! I don't think we gave a good enough overview of the way
documentation will be handled in version 4, so hopefully this announcement
will clarify that.
--
-- To post, send email to [email protected]. To unsubscribe, send
email to [email protected]. For more information,
visit https://groups.google.com/d/forum/archesproject?hl=en
---
You received this message because you are subscribed to the Google Groups
"Arches Project" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
