Epic: Enhancing ODK-X Developer Documentation for Improved Usability

[permission-error]

Tag: @wbrunette @elmps2018

I've been actively seeking out ODK-X developer documentation, and I've identified the primary resource at ODK-X Developer Environment Setup. While this documentation is a solid foundation, there's room for enhancement without making it overly complex.

Here's what we can consider:

1. Detailed Content: The existing documentation lacks depth, which could pose challenges for junior developers. We should aim to provide more comprehensive explanations and instructions.

2. Streamlined Tool Downloads: Currently, users are directed to external websites for tool downloads, which may not be the most user-friendly approach, especially for Linux and Mac users. To simplify this, we can incorporate direct command-based instructions for tool downloads.

3. Illustrative Tutorials: To enhance clarity, we could introduce tutorials with accompanying screenshots. This visual guidance can be particularly helpful for those who prefer a more hands-on approach.

[elmps2018]

Hi @permission-error! Thanks for investigating. Another important resource (that may need to be cross-linked) is here: https://docs.odk-x.org/advanced-topics-developer/

I think what you are linking to is the development environment setup specifically.

Take a look at https://docs.odk-x.org/advanced-topics-developer/ and see if it addresses these points.

[permission-error]

I think what you are linking to is the development environment setup specifically.

@elmps2018 Ya sure, you correct. This is what is not clear somehow. I think thats typically what we have to improve because I cant find it here as well https://docs.odk-x.org/advanced-topics-developer/

[elmps2018]

Decision from discussion at the community call: Don't want to duplicate content from docs here, this may need updating/deleting, and could point to the docs link above.