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

New documentation theme #3376

Merged
merged 89 commits into from
Jun 8, 2015
Merged

New documentation theme #3376

merged 89 commits into from
Jun 8, 2015

Conversation

kevin-brown
Copy link
Member

This incorporates work done by @fk to design a new documentation theme which is a bit more user friendly.

Feedback is greatly appreciated.

Florian Kissling added 30 commits April 9, 2015 20:27
 * adds styles for anchor.js (similar to the official Bootstrap docs)
 * currently results some of the generated links to have a suffix (e. g. examples.html#templating-1) added due to sections having the same ID as the headline copy that we want to link to
Adds

 * version information
 * links to the GitHub repository, issues and releases
 * links to the examples and options
 * a link to the 3.5.2 docs

to the footer as well as namespaced styles for the footer in general as well as all the above.
With the additional footer navigation in place, it should be safe to remove these.
While the latter is part of the docs, the "Release notes" are linked to the GitHub "Releases" section; thus the added divider.
This also gets rid of the colored buttons in favor of `.btn-default`, prevents wrapping of the "Destroy" button of the first button group of the "Programmatic access" demos to a second line and consistently places buttons below the Select2 widgets they apply to.

Ref. http://getbootstrap.com/components/#btn-groups.
Borrowed from the Bootstrap doc implementation.
@fk
Copy link
Member

fk commented May 31, 2015

Hi @kevin-brown thanks for the pull request.

There's still some things left to do, from the top of my head:

  • there currently are two "Remote data support" blocks in the .s2-docs-featurette rows in index.html – we can delete one of the two or use it to point out another feature
  • none of the links in .s2-docs-featurette actually point somewhere, they all are placeholders

I'll see if I can figure out the linking thing myself, but I'd like to request your help with the "Remote data support" block. I'll have some time tomorrow to do so.

kevin-brown and others added 11 commits May 31, 2015 14:53
This adds correct links to the linked text on the front page under
the features section. There is still one panel which needs to be
written, the last one that includes the AJAX text again, before it
can really be considered finished.

The wording around the Bootstrap theme was adjusted pending further
discussion about how that is going to be handled.
This adds the final box, which I've chosen to be for the browser
support (though that can be changed).

The last two boxes on the first row have also been swapped, partially
because the text sizes now match the second row, but also because
the AJAX support should be more prominent than the theme support.
Conflicts:
	docs/examples.html

In the docs-improvements branch, the docs examples live in partials located in docs/_includes/examples.
The updated AJAX example code from #3357 – the conflicting addition to docs/examples.html – has been ported to the appropiate partial in docs/_includes/examples.data.html.
@kevin-brown
Copy link
Member Author

Previews of how it looks.

The new home page: https://i.imgur.com/qxYrUqb.png
Examples: https://i.imgur.com/EVJB4Bz.jpg
Options (still waiting to be overhauled): https://i.imgur.com/8bHsuFT.jpg
4.0.0 release announcement: https://i.imgur.com/sD98o0v.jpg
Community: https://i.imgur.com/ySF6BWD.png

kevin-brown added a commit that referenced this pull request Jun 8, 2015
@kevin-brown kevin-brown merged commit 44cd938 into master Jun 8, 2015
@kevin-brown kevin-brown deleted the docs-improvements branch June 8, 2015 00:48
@cyberbit
Copy link

👍 Really like the new design! It's significantly more "Bootstrappy," which is a good thing. :D Props to @fk!

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

Successfully merging this pull request may close these issues.

3 participants