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

Reorganize the Documentation #394

Closed
9 tasks done
prmr opened this issue Nov 30, 2020 · 0 comments
Closed
9 tasks done

Reorganize the Documentation #394

prmr opened this issue Nov 30, 2020 · 0 comments
Assignees
@prmr
Labels
docs Issues with documentation feature A feature request
Milestone
Release 3.1

Comments

@prmr
Copy link
Owner

prmr commented Nov 30, 2020 •
edited
Loading

Reorganize the documentation pages to account for the presence of the user guide.

  • Migrate main site to GitHub Pages
  • Create a documentation table of contents section on the main page
  • Create the user guide page
  • Clean up the installation page and link it from the main page
  • Create a new developer page and move the content from the wiki to there
  • Deal with the architectural documentation
  • Retire the wilki
  • Add link to user guide from the Help Menu
  • Add complete set of Tips of the Day
@prmr prmr self-assigned this Nov 30, 2020
@prmr prmr added docs Issues with documentation feature A feature request labels Nov 30, 2020
@prmr prmr added this to the Release 3.1 milestone Nov 30, 2020
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Update README with documentation TOC
b4b3e32
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Rename architecture description page
fcd3bee
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Update compatibility guide
9b3f459
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Add developer guide
9a62504
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Add file extensions
3386cfb
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Add additional versions in installation guide
fc473d1
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Fix typos in paths
05f8d59
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
Merge pull request #396 from OlivierGL/NoJekyllTheme
2bd955a 
#394 User Guide (2)
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Link user guide to GitHub page version
800911e
prmr added a commit that referenced this issue Nov 30, 2020
@prmr
#394 Slightly tighter layout
965eea9
prmr added a commit that referenced this issue Dec 1, 2020
@prmr
#394 Add User guide menu under Help
afad70e
@prmr prmr closed this as completed Dec 3, 2020
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Update README with documentation TOC
c3e0001
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Rename architecture description page
da692b1
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Update compatibility guide
38459ca
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Add developer guide
6895d95
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Add file extensions
15ac603
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Add additional versions in installation guide
1b5b0ea
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Fix typos in paths
bc21ba1
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Link user guide to GitHub page version
3c23462
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Slightly tighter layout
8b01efe
prmr added a commit that referenced this issue Dec 4, 2020
@prmr
#394 Add User guide menu under Help
07dc387
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@prmr prmr

Labels
docs Issues with documentation feature A feature request
Projects
None yet
Milestone
Release 3.1
Development

No branches or pull requests
1 participant
@prmr