Giter VIP home page Giter VIP logo

Comments (6)

jonschlinkert avatar jonschlinkert commented on May 23, 2024

@ChrisCinelli can you clarify what you meant with the "BONUS" point? At first it sounds like you're referring to tags on the Less.js repo, then it sounds like you're referring to tags on the lesscss.org repo...?

from less-docs.

ChrisCinelli avatar ChrisCinelli commented on May 23, 2024

Example: I have some products that use bootstrap v1. For maintenance I had to find a link to the documentation provided by somebody else.
I think it would be great to have always on the homepage the doc regarding last released version.
But at the end of the page in the Changelog session it would be nice to have the version numbers (ex: 1.0, 1.1, 1.3.3, 1.4.2 etc) that link the old versions of the documentation.
In this way the latest version of the documentation can be clean instead of having: "in v 1.4 this behave like this, but in v 1.3.3 it behave like that". The changelog and the older documentation should be enough to get all the necessary info.
I would add that in the changelog you could have also a migration/incompatibility link.

Ex:

    <h1>Changelog</h1>
    <h2><a href="/doc-v142/index.html">v.1.4.2</a></h2>
    <span class="migration">Migration guide from v 1.3.3</span><br/>
    <ul> ... </ul>

If the version numbers are x.y.z (like in 1.3.3) and the z are just bug fixes (that is probably a good idea), we just need a migration guide only between different x.y versions.

I called it "bonus" because in the list at less/less.js#1050 (comment) this was the point that was probably taking the longest while the others seemed more important, deliver immediate value and doable in less than 2 hours with the current lesscss.org code.

from less-docs.

jonschlinkert avatar jonschlinkert commented on May 23, 2024

I was just trying to clarify which repo you were referring to when you mentioned the tags. A while ago I ported the CHANGELOG to yaml and have templates setup to be able to do what you're suggesting (both lodash and handlebars). I just wanted to clarify because I can easily have the links dynamically generated as well, and I wanted to make sure that it would be done in a way that made sense based on your suggestion.

thanks for clarifying, this is helpful

from less-docs.

Soviut avatar Soviut commented on May 23, 2024

Django has a good example of versioned documentation. It even warns you if you're looking at docs for a "work in progress" development build.

https://docs.djangoproject.com/en/1.5/

Notice the version number in the docs url as well as the version changing widget at the bottom right.

from less-docs.

jonschlinkert avatar jonschlinkert commented on May 23, 2024

I love the idea. I think we can easily work this in. I'm working hard to get everything consolidated so I can start pushing stuff up.

from less-docs.

SomMeri avatar SomMeri commented on May 23, 2024

Closing this since change log is kept now .

from less-docs.

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.