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

Docs UX improvements [docs-ux] #2023

Open
sqs opened this Issue Jan 25, 2019 · 3 comments

Comments

Projects
None yet
4 participants
@sqs
Copy link
Member

sqs commented Jan 25, 2019

Placeholder for tracking issue for 3.1. We will plan this together in the week of 2019-01-28.

Issues labeled docs-ux

  • Make docs pages more visually appealing and fix style #2052
  • Improve cross-page navigation and overview to leaf page navigation #2060
  • Make in product help consistent with docs site #1885, #1720
  • Update docs.sourcegraph.com to make 3.0 current #2242

@sqs sqs added docs roadmap labels Jan 25, 2019

@sqs sqs added this to the 3.1 milestone Jan 25, 2019

@sqs sqs added the docs-ux label Jan 29, 2019

@sqs sqs changed the title Docs improvements Docs improvements [docs-ux] Jan 29, 2019

@sqs sqs changed the title Docs improvements [docs-ux] Docs UX improvements [docs-ux] Jan 29, 2019

@ryan-blunden

This comment has been minimized.

Copy link
Contributor

ryan-blunden commented Jan 29, 2019

#2060 has been created to track how and what will be done to improve cross-page navigation and overview.

sourcegraph/docsite#7 has been created to decide how the page index will be managed. This needs to be decided upon before development can be begin.

@nicksnyder

This comment has been minimized.

Copy link
Member

nicksnyder commented Feb 12, 2019

I have two more things to add to this tracking issue:

  1. It is a pain that we have to make a change to the docsite template to update version links separately from updating the documentation itself.
  2. I am not convinced that it is worth the effort for us to maintain our own docsite generator in the long run compared to using an available alternative.
@francisschmaltz

This comment has been minimized.

Copy link
Member

francisschmaltz commented Feb 12, 2019

@nicksnyder I agree. We should take something prebuilt that we can iterate on.

@ryan-blunden ryan-blunden modified the milestones: 3.1, 3.2 Feb 13, 2019

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