Open ect123 opened 1 year ago
Include technical prerequisites for developer documentation, and make the markdown template a downloadable file.
README.md is updated but needs review on technical documentation. The link for the markdown template needs to be tested once the update-readme
branch is merged to develop.
README.md is updated but needs review on technical documentation. The link for the markdown template needs to be tested once the
update-readme
branch is merged to develop.
The link was broken and has been fixed.
Information has been added to the tutorial.md on the update-tutorial-page
branch. After updating it, I wondered if the information about what the OIMOM is might be better suited to living on the home page. Additionally, the "how to" section might benefit from being on the same page as the mapbox, so that users can follow along with each step without needing to switch pages to read the directions. Any thoughts, @ect123?
As we discussed, let's see if we can migrate the tutorial content to an info "window" or "content box" that is visible to the user on each map view pages. The box should be toggle-able so that it takes up a minimal amount of space on the page, by using a button, icon, or some other visual cue to turn on or display. Once this is done, then we don't need the extra page.
README.md and tutorial content are both integrated, which leaves the "About" page on the OIMOM with information about the project and the library itself.
Migrate existing documentation to appropriate pages: