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.

Sign up for GitHub

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

Jump to bottom

Consolidate Documentation #2

Open
justingeeslin opened this issue Jun 10, 2020 · 3 comments
Open

Consolidate Documentation #2

justingeeslin opened this issue Jun 10, 2020 · 3 comments
Assignees
@justingeeslin
Labels
documentation Improvements or additions to documentation
Milestone
Documentation In-...

Comments

@justingeeslin
Copy link
Member

There are helps for CogTool sprinkled around the web including in the canonical CogTool GitHub repo. Here are source that we know of that we'd like to consolidate into one place.

Doc Sources

  • the canonical CogTool GitHub repo
  • the CogTool User Guide (currently PDF)
  • YouTube webinar on CogTool
  • wayback machine of CMU site
  • CogTool Wordpress blog from 2014

Possible Doc Destinations

  • GitHub pages within this repo (preferred, for reasons below)
  • Another Wordpress blog
  • GitHub Wiki

On GH Pages

One keen advantage to GitHub pages is that it forces you to keep the docs in the branch of code that the docs support.
@justingeeslin justingeeslin added the documentation Improvements or additions to documentation label Jun 10, 2020
@justingeeslin justingeeslin self-assigned this Jun 10, 2020
@justingeeslin justingeeslin added this to the Documentation In-branch milestone Jul 5, 2020
@justingeeslin
Copy link
Member Author

Added the Tutorial to the website. Progress on the user guide is captured in feature/user-guide-html.

@justingeeslin
Copy link
Member Author

Added the UXMN-PA webinar.

@justingeeslin
Copy link
Member Author

I'm currently, slowly moving over the CogTool forums from the CMU website as captured in the Wayback Machine.

Revisiting these forums I've found answers to some of my questions as well has answers to question people have written me with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@justingeeslin justingeeslin

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Documentation In-branch
Development

No branches or pull requests
1 participant
@justingeeslin