Giter VIP home page Giter VIP logo

Comments (7)

brillout avatar brillout commented on May 12, 2024 1

Released 0.1.0.

from vike.

chrisvariety avatar chrisvariety commented on May 12, 2024

👍 Upgrade to v0.1.0-beta.45 went fine FYI (and upgrades in-between the betas), I think we're ready.

from vike.

brillout avatar brillout commented on May 12, 2024

Yes, we are almost there :-).

There is one last breaking change #76, which I'll ship tentatively today. After a couple of days I'll release 0.1.0 :-).

I know breaking changes are annoying but it's worth it long term. Once we are out of beta you can expect an order of magnitude less breaking changes. I also aim for 1.0.0 soon, after I do some marketing for vite-plugin-ssr.

One long-term neat thing here is that, because vite-plugin-ssr is not tied to React/Vue/..., there will actually be much less breaking changes than Next.js and Nuxt.

from vike.

chrisvariety avatar chrisvariety commented on May 12, 2024

@brillout no problem updating to v0.1.0-beta.46 either, FYI.

For 1.0.0 I'd recommend a docs website vs. a reallllly long readme, which is great, don't get me wrong, just multiple pages would help organize.

from vike.

brillout avatar brillout commented on May 12, 2024

Thanks for the info 👍 .

I'd recommend a docs website vs. a reallllly long readme, which is great, don't get me wrong, just multiple pages would help organize.

How does it help organize?

I'm the author of the Readme so for me the structure of it is clear. I'd definitely appreciate help to get an idea of how the table of content works for someone who isn't me.

from vike.

chrisvariety avatar chrisvariety commented on May 12, 2024

@brillout sure, it's more of a UX thing. If you look at other similar projects, at a certain size they grow out of the Readme and onto a dedicated docs site. Personally, I find seeing that much content all at once overwhelming, like you don't really know where to begin, and once I click on something, I feel stuck in the middle (though just discovered Github has nice ways to reveal table of contents and scroll to top, not sure everyone knows about those.) See e.g.

https://vitejs.dev/guide/
https://mswjs.io/docs/
https://chakra-ui.com/docs/

All of these have a sidebar which contains the table of contents, allowing for easy navigation. Search is a huge plus too, but not 100% necessary for an MVP.

https://www.gitbook.com is an easy way to spin something like this up, but there are a lot of alternatives out there as well.

from vike.

brillout avatar brillout commented on May 12, 2024

Makes sense, created a ticket for it #78.

from vike.

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.