Giter VIP home page Giter VIP logo

Comments (4)

dlech avatar dlech commented on July 30, 2024

I'm working on moving all of the driver docs to readthedocs.org infrastructure so that we can have multiple simultaneous version, etc. So, I don't think it is worth doing anything with this issue.

from ev3dev.github.io.

WasabiFan avatar WasabiFan commented on July 30, 2024

That looks good to me; I never took the time to properly respond to that issue, but I concluded a while ago that it's impossible for us to maintain multiple versions of documentation on our site. Assuming you haven't done so already, if you give me info on how you're structuring the docs site (and/or access to the current instance) I can get it integrated into the main site nav.

from ev3dev.github.io.

dlech avatar dlech commented on July 30, 2024

Here is what I have so far: http://docs.ev3dev.org/projects/lego-linux-drivers/en/sphinx-doc/

My plan was just to make redirects for existing pages and have a link to docs.ev3dev.org and manage everything from there since readthedocs has built-in search.

from ev3dev.github.io.

WasabiFan avatar WasabiFan commented on July 30, 2024

Looks good! I mainly want to make sure that we don't break any existing links to www.ev3dev.org proper (read: set up redirects). We also need to figure out how our existing search system works; one simple option is to provide a link to the RTD search page in our results view. Preferably, attempts to find the driver docs on our main website should still get you to the new location. There may also be the possibility of requesting search results from them; I'll have to look. It's nice to get the "clutter" of the low-level technical stuff grouped up and separated; most people don't need it at this point.

We need to figure out how to wire up navigation; preferably, we can make the nav somewhat match the main ev3dev.org header and then have the links switch between the two (with icons for external links). Is there a Read the Docs theme that more closely matches our site theme?

P.S. Is there a way to make it so that docs.ev3dev.org links to something useful? Presumably you can create an index.rst file.

from ev3dev.github.io.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.