Coder Social home page Coder Social logo

Changelog looks bad on gitbook about sourced-ce HOT 4 CLOSED

src-d avatar src-d commented on June 14, 2024
Changelog looks bad on gitbook

from sourced-ce.

Comments (4)

dpordomingo avatar dpordomingo commented on June 14, 2024

I think it's a good idea to show the Changelog in our docs (which is a common thing in the industry)

The problem is that GitBook does not support HTML code (only plain Markdown), so the HTML tag <details>, used to collapse the unreleased changes, is not supported.

Since we already agreed on avoiding HTML code, I'd purpose some alternatives:

  • separate the unreleased changes into a new file, example: Changelog.unreleased.md, or
  • since the unreleased section could not be collapsed, move it to the bottom of the CHANGELOG file.

For both alternatives, we could add a link to the unreleased changes in the top section of the original Changelog.

wdyt?

from sourced-ce.

carlosms avatar carlosms commented on June 14, 2024

Let's think about more permanent solutions in the next iterations.
For this very first release let's just hide it.

from sourced-ce.

dpordomingo avatar dpordomingo commented on June 14, 2024

Already hidden in my pr

from sourced-ce.

dpordomingo avatar dpordomingo commented on June 14, 2024

People from DP just show the unreleased stuff as another item, i.e. src-d/gitbase/CHANGELOG.md
I'd vote for that.

from sourced-ce.

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.