Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate documentation #42

Open
ect123 opened this issue Jan 11, 2023 · 6 comments
Open

Migrate documentation #42

ect123 opened this issue Jan 11, 2023 · 6 comments
Assignees

Comments

@ect123
Copy link
Contributor

ect123 commented Jan 11, 2023

Migrate existing documentation to appropriate pages:

  • about.md (about the collection, maps, etc.)
  • tutorial.md (how to use the application)
  • README.md (project/technical documentation for anyone hoping to reuse the site)
@ect123
Copy link
Contributor Author

ect123 commented Jan 11, 2023

Include technical prerequisites for developer documentation, and make the markdown template a downloadable file.

@nickmmurphy
Copy link
Contributor

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.

@nickmmurphy
Copy link
Contributor

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.

@nickmmurphy
Copy link
Contributor

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?

@ect123
Copy link
Contributor Author

ect123 commented Jan 31, 2023

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.

@nickmmurphy
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants