How to Separate User Documentation and Developer Documentation?
I'm setting up the documentation for a free software project that I'm working on and am thinking about how to structure the documentation. I'm using github for hosting with a github pages site as the entry point for new users, and I'm also using readthedocs.org
I'm considering how to separate the developer documentation from the user documentation to avoid scaring new potential users away
My thinking so far: On the github pages site I'd like to mostly present things for (potential) users but at the end of the site give a link to the developer documentation (which would be placed in my source repository under the docs/
directory and could be used for readthedocs generated documentation). Any user documentation (hopefully I don't need too much as the goal is to make the software self-explanatory) could just be placed on the github pages site
Is this a good approach? What are some general considerations to make when separating user documentation and developer documentation?
My goals are to find both users of the software and also developers, to be inviting to both groups and to make it easy to get started (using the software and developing the software)
Grateful for help with this!