Coder Social home page Coder Social logo

Permalink a latest about docs-italia-theme HOT 3 OPEN

italia avatar italia commented on August 10, 2024 1
Permalink a latest

from docs-italia-theme.

Comments (3)

pdavide avatar pdavide commented on August 10, 2024 1

@alexrj @atorin secondo me ogni documentazione dovrebbe avere un permalink che permetta di raggiungere l'ultima versione (stabile). Attraverso il tema non è possibile incidere sulla logica di generazione dei path che invece dipende proprio dal concetto di "versione" su RTD.
Per le "Linee guida di design" l'approccio adottato è quello descritto nel paragrafo Version control e release della documentazione, ma non è detto che questo modello si possa applicare a tutte le tipologie di documenti.
Dal punto di vista del tema, c'è una piccola accortezza che è stata implementata (con questo modulo) su "Linee guida di design" che fa in modo che se anche l'url è .../stable/..., nel badge della barra laterale è visualizzato il corretto numero di versione anziché la stringa "stable".

from docs-italia-theme.

alterat avatar alterat commented on August 10, 2024

@alexrj grazie per la segnalazione.

Per quanto riguarda il CAD, posso aggiungere la versione latest senza particolari problemi. L'avevo eliminata per ragioni di "pulizia" delle versioni, ma capisco che questa strategia possa portare dei problemi.

In generale, concordo sulla possibilità di specificare meglio come taggare i documenti. Non so invece se valga la pena lavorare a livello di tema, ma su questo lascio la parola agli sviluppatori.

from docs-italia-theme.

alterat avatar alterat commented on August 10, 2024

@pdavide sono d'accordo con l'approccio descritto nelle Linee guida, che abbiamo confermato anche nella Guida a Docs Italia.

La soluzione potrebbe essere di attivare, per ogni documento, sia la versione latest che stable, inserendo questa prescrizione nella Guida?

Il concetto di "versione" è legato secondo me al contenuto del documento, più che al suo aspetto esteriore, quindi al di là delle possibili difficoltà tecniche, non gestirei questo aspetto a livello di tema.

from docs-italia-theme.

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.