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

Documentation updates and organisation #3584

Merged
merged 5 commits into from May 1, 2018

Conversation

Projects
None yet
1 participant
@takluyver
Copy link
Member

takluyver commented Apr 29, 2018

This is mostly a list of common problems, so that people can work through the first steps we'd ask them to try before asking for help. Or we can point people to it if it looks like they're having one of those issues.

@takluyver takluyver added this to the 5.5 milestone Apr 29, 2018

@takluyver

This comment has been minimized.

Copy link
Member Author

takluyver commented Apr 30, 2018

This extended into a general tidy up of the home page. In particular, I want the top level table of contents to fit on one reasonable sized screen, and I want all the links in the sidebar to stay within the site, so you can click through them without being thrown to another site altogether.

Before:

screenshot-2018-4-30 the jupyter notebook jupyter notebook 5 4 1 documentation

After:

screenshot-2018-4-30 the jupyter notebook jupyter notebook 5 5 0 dev0 documentation

takluyver added some commits Apr 30, 2018

@takluyver takluyver changed the title Add troubleshooting documentation Documentation updates and organisation Apr 30, 2018

@takluyver

This comment has been minimized.

Copy link
Member Author

takluyver commented Apr 30, 2018

And I found that no-one had updated the introductory documentation page in a couple of years, so this PR now covers that.

@takluyver

This comment has been minimized.

Copy link
Member Author

takluyver commented May 1, 2018

I'm happy that this is an improvement, though there may be further improvements to be made, so I'm going to merge it and try to make a release candidate of notebook 5.5.

@takluyver takluyver merged commit 7a623d6 into jupyter:master May 1, 2018

4 checks passed

codecov/patch Coverage not affected when comparing 2aca6f9...dd687fb
Details
codecov/project 74.38% remains the same compared to 2aca6f9
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@takluyver takluyver deleted the takluyver:doc-troubleshooting branch May 1, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.