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

Re-merging intranet.neuro.polymtl.ca <-> neuro.polymtl.ca #30

Open
kousu opened this issue Nov 4, 2021 · 1 comment
Open

Re-merging intranet.neuro.polymtl.ca <-> neuro.polymtl.ca #30

kousu opened this issue Nov 4, 2021 · 1 comment
Labels
revision Content and reading flow

Comments

@kousu
Copy link
Member

kousu commented Nov 4, 2021

I think we should keep all the docs in a single repo. The only reason the old dokuwiki content was split to two repos (https://github.com/neuropoly/neuropoly-docs/ and https://github.com/neuropoly/neuropoly-internal-docs/) was because the table of contents that generated got too deep. But if we accept #21 then we have much more control over the table of contents than we do with Gitbook.

I would take all the .md files currently in https://github.com/neuropoly/neuropoly-internal-docs/ and put them in a subfolder called '/lab-manual' nin this repo.

But:

Originally posted by @jcohenadad in #21 (comment)

About merging the internal lab and external lab website: i'm still not 100% sure if we should do it. What would be the pros/cons, etc. I see how it could be confusing for external people visiting our lab website (ie: many entries in the TOC, overwhelming, etc.)

I still think we can tame this. We can use a custom sidebar template. https://sphinx-book-theme.readthedocs.io/en/latest/customize/sidebar-primary.html#control-the-left-sidebar-items gives an example: under /blog their sidebar gets special formatting for blog posts; we could use the same to have pages under /lab-manual start the table of contents at itself, and making sure to set :maxdepth: 3 to prevent the primary ToC from spiraling.

@kousu
Copy link
Member Author

kousu commented Nov 4, 2021

Leaving this wide open for reflection and comments from the lab!

@kousu kousu changed the title Re-merging intranet.neuro.polymtl,ca <-> neuro.polymtl.ca Re-merging intranet.neuro.polymtl.ca <-> neuro.polymtl.ca Nov 4, 2021
@kousu kousu added the revision Content and reading flow label Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
revision Content and reading flow
Projects
None yet
Development

No branches or pull requests

1 participant