Commit Graph

24 Commits

Author SHA1 Message Date
Tim Abbott 57ca19392e help: Make API context available to sidebars.
I am not a fan of this API (where we need to pass context into
`render_markdown_path` directly), but it seems more robust to pass
this in directly.
2018-04-05 12:22:41 -07:00
Tim Abbott f1ece37455 help: Fix context not being passed properly to rendering.
This contributed to settings_html, subscriptions_html and friends not
being rendered properly in the /help/ views.
2018-04-05 11:43:48 -07:00
Cynthia Lin c31e148ea8 user docs: Add links back to homepage to the bottom of the sidebars. 2017-12-31 08:08:25 -05:00
Cynthia Lin b7fb86b9ea user docs: Modify sidebar and index page styling. 2017-12-07 14:40:17 -08:00
Tim Abbott 054952a44a docs: Update links from codebase to point to ReadTheDocs. 2017-11-16 10:53:49 -08:00
Brock Whittaker d2e55fa5c8 /api/ & /help/: Change index to <h1>.
The Index should be presented as an <h1> section and to the far left.
2017-11-08 13:01:33 -08:00
Brock Whittaker 228b0c4290 /help/: Add a slide class for sidebars that should have slide mechanism.
This adds a slide class that specifies that the JS actions for sliding
up and down sections is the desired behavior, along with a bit of CSS
to help display correctly in the case of not being a sliding section.
2017-11-08 13:01:33 -08:00
Rishi Gupta fd0fc77f92 user docs: Use sentence case for titles of sections.
Also changes "Main Index" to "Index", since "Main index" doesn't look great.
2017-10-05 23:12:24 -07:00
Brock Whittaker c9514d0ad2 /help/: Remove underline and changes text from "Index" => "Main Index".
This removes the underline on hover and changes the text to get to the
index.

This also changes it to an <h2> tag so that it will be more inline
with the styling of the rest of the sections, but without the
down chevron.
2017-10-03 16:36:37 -07:00
Cynthia Lin ea75772a01 user docs: Add index page for searching. 2017-10-03 11:13:36 -07:00
Brock Whittaker c8641d49b5 /help/: Remove portico footer.
I don't think we need the footer in here.
2017-08-28 11:07:03 -07:00
Brock Whittaker 44636051e4 Make /help/ sidebar more discoverable on mobile/narrow.
This makes the /help/ sidebar more discoverable at windows less
than 1000px in width because it makes it stick out a bit when it
is closed with the hamburger menu at the top.

Fixes: #6038.
2017-08-24 13:38:22 -07:00
Tim Abbott 41f37d0a6f jinja2: Use function interface for render_markdown_path.
Apparently, the filters implementation was doing some sort of strange
caching, where you would need to restart the server in order to
refresh for changes to the markdown content.

We fix this by switching to just calling the render_markdown_path
function from Jinja2.

Fixes #5974.
2017-07-31 14:54:54 -07:00
Brock Whittaker 1cf7ee966b help: Redesign /help/ pages to be a single page app.
This redesigns the /help/ page sets to be a single page app that uses
history.pushState to work the same as the old app.

The big new feature is that now we have the index in a nicely designed
left sidebar.
2017-07-13 15:43:44 -07:00
Aditya Bansal 9219298774 Clean main.html to use 4 space indentation. 2017-06-06 22:04:55 -07:00
Brock Whittaker 48ac49385e Fix lack of uniformity with box content layout.
The various portico pages had various styling differences that made
them less consistent when responsive.
2017-05-04 16:09:12 -07:00
Tim Abbott bbecd41376 help: Fix link to index page being present on index page.
Fixes #3613.
2017-02-18 14:59:43 -08:00
Brock Whittaker 5f6632c9e9 Add "back to home" button at top of help pages.
This adds a button that will bring a user back to the home
of the help section "/help".
2017-02-10 21:46:09 -08:00
Rishi Gupta d8012c5b7b user docs: Change footer to be less prominent. 2017-01-31 18:17:49 -08:00
Brock Whittaker 04dfa2071f Remove unnecessary terms-page-container class.
This removes the terms-page-container class from the markdown div and
thereby removes the necessary 40px padding at the top of the div.
2017-01-27 11:41:35 -08:00
Steve Howell fb9ac98510 Fix lint error with help/main.html template. 2017-01-11 14:58:53 -08:00
JefftheBest1 7f7df149ae Added footer to all user docs. Fixes #3112 2017-01-11 14:24:56 -08:00
Brock Whittaker 105ef7caae Add markdown page styling.
This styles inline images, the markdown page as a whole, and the
notification buttons to be CSS rather than images.

[Tweaked by tabbott to temporarily remove the Yantramanov font, since
we should be committing that to the repo so Zulip works correctly without
Internet access]
2016-12-15 21:59:58 -08:00
Tim Abbott cf2007d4e0 docs: Add a simple markdown-based help center.
The plan is to use this for adding user documentation to Zulip.
2016-11-09 21:39:55 -08:00