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

Scrollable one-page for /docs #8

Open
joenash opened this issue May 20, 2020 · 3 comments
Open

Scrollable one-page for /docs #8

joenash opened this issue May 20, 2020 · 3 comments
Labels
Category: Functionality The documentation's functionality Change: Non-Breaking A change that will not break links to the site Difficulty: Core Contributor Should only be attempted by a core contributor Priority: Medium Should be completed in the next few sprints Size: Medium Requires a medium time commitment Type: Enhancement An enhancement to the docs site

Comments

@joenash
Copy link
Contributor

joenash commented May 20, 2020

General Summary

Render all of a given submodule as a scrollable one-page.

Motivation

An alternate mode of viewing the page that facilitates long reads and vigorous ctrl-f'ing.

@joenash joenash added Category: Functionality The documentation's functionality Change: Non-Breaking A change that will not break links to the site Difficulty: Core Contributor Should only be attempted by a core contributor Priority: Medium Should be completed in the next few sprints Size: Medium Requires a medium time commitment Type: Enhancement An enhancement to the docs site labels May 20, 2020
@iamrecursion
Copy link
Contributor

The one page should be on a per-repo basis, I think. I don't think we want to merge developer docs from different repos into a single page, do you?

@joenash
Copy link
Contributor Author

joenash commented May 20, 2020

Agreed, sorry that's what I was going for with of a given submodule

@joenash
Copy link
Contributor Author

joenash commented May 20, 2020

Thinking on implementation, we could either generate a one pager for each directory in route, or add a frontmatter field to a README which we look for to then create a one pager from all the files/directories below it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Functionality The documentation's functionality Change: Non-Breaking A change that will not break links to the site Difficulty: Core Contributor Should only be attempted by a core contributor Priority: Medium Should be completed in the next few sprints Size: Medium Requires a medium time commitment Type: Enhancement An enhancement to the docs site
Projects
None yet
Development

No branches or pull requests

2 participants