Comments (8)
I agree with your concerns Loic. Currently readibility and layout are problematic. It would require major tweaking with the theme. The color palette can be made more "neurolibresque", but the colors are indeed quite harsh for notes, warnings etc. At this stage I would also be in favour to go back to the previous theme. Also, I don't think it is a big deal to have different color palettes for the docs and the main website.
from docs.neurolibre.org.
Up to y'all, of course, how you want to handle it. All of the current concerns can be quickly addressed in the conf.py and in some light CSS, but I was trying to have something a bit slicker than the default RTD theme if we'd like to have it clickable from some of the Hugo themes without a significant thematic shit.
I don't think this is my part of the project, though, so I was just offering one option.
from docs.neurolibre.org.
If we want to have a less thematic shift, maybe we could just change the color palette (from RTD theme) as pierre pointed out ? what do you think @emdupre ? For example with a white background instead of the blue we could keep the original red neurolibre logo
from docs.neurolibre.org.
I don't think just a color change will avoid the thematic shift (although it will be an important part, once the skeleton is finalized). I was looking at e.g. ObservableHQ, which @agahkarakuzu had suggested as one possible inspiration source for NeuroLibre: https://observablehq.com/explore
Their navigation is along the top, much as in the Sphinx-Bootstrap theme -- honestly, it's likely based on Bootstrap itself. If you stick with the RTD theme, you'll switch from a top navbar to a side one, which is a shift no matter the color scheme 😸
Again, though, this isn't really my arena, so only offering options.
from docs.neurolibre.org.
I have never tweaked a sphinx theme, so not sure how much work this will be. I agree with Loic that the RTD theme looks more polished out of the box, but let's see if we can get this sorted. It would be neat to have a consistent style for the docs and the main site. @agahkarakuzu @mathieuboudreau let me know if you would have time / be interested in looking into this. Otherwise I'll try.
from docs.neurolibre.org.
OK so I have slept on this. I don't think it's a good idea to match the style of the docs to the main website. The docs aimed at authors/reviewers should be integrated directly in neurolibre.com. Hugo is perfectly apt to do that, and it will be less confusing than being bounced around different sites. The technical documentation is aimed at developers, and should have its own identity. The content would be limited to https://docs.neurolibre.com/en/latest/INFRASTRUCTURE.html, which would be split into different sections.
from docs.neurolibre.org.
OK so I have slept on this. I don't think it's a good idea to match the style of the docs to the main website. The docs aimed at authors/reviewers should be integrated directly in neurolibre.com. Hugo is perfectly apt to do that, and it will be less confusing than being bounced around different sites. The technical documentation is aimed at developers, and should have its own identity. The content would be limited to https://docs.neurolibre.com/en/latest/INFRASTRUCTURE.html, which would be split into different sections.
I was exactly thinking the same!
from docs.neurolibre.org.
Based on internal poll, we'll switch back to RTD theme for now. Exact content for docs still in discussion.
from docs.neurolibre.org.
Related Issues (20)
- maintain URLs and meta-data HOT 1
- document wall time HOT 7
- document data limits HOT 3
- document jb debugging HOT 3
- First documentation review
- Weird things to document
- update documentation for reviewers
- create a link to the logo archive
- start an editor section
- document "in scope" decision HOT 2
- document "start metareview"
- document meta-review on github
- document editor invitation
- update reviewer documentation HOT 1
- document featured.png at the root
- Note on submodule remote protocol HOT 3
- Point to a minial example repository in the author guideline doc HOT 4
- _config.yml link does not work HOT 1
- Adding a Quick Start document
- create docs for readers
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.neurolibre.org.