Coder Social home page Coder Social logo

This repo needs a readme! about docs HOT 9 CLOSED

nodejs avatar nodejs commented on July 21, 2024
This repo needs a readme!

from docs.

Comments (9)

Qard avatar Qard commented on July 21, 2024

Yeah, it seems to me that GETTING-STARTED.md and CONTRIBUTING.md should be probably part of README.md, or at least referenced in it.

It is indeed a bit preliminary. Some docs have been put together, but I think there was a bit of uncertainty how this would all fit together post-foundation-merge. Now that node 4.0.0 is out, I think that picture is becoming clearer and we should probably do another docs meeting to discuss the road forward.

As for an entry point, Issue #1 has a link to a trello board where we compiled a wishlist of sorts for what we want documented and roughly what sort of structure we think would be most effective. I've mostly been focused on documenting internals to lower the barrier to entry for new contributors. We need all sorts of content though.

from docs.

danielkhan avatar danielkhan commented on July 21, 2024

I agree with @Frijol and @Qard. For me it was a bit confusing that we had quite a discussion on if I should cover installing io.js in the installation doc just to later find out that the docs don't yet end up at the new website for 4.0.0 anyway. Now having only to cover 4.0.0 is a relief, though.

Unfortunately I haven't yet understood the context in which for instance a installation doc will be shown.
If someone could show maybe another project that accomplished what we want to achieve it might be easier to jump in. But that's just my opinion - I'm not sure if I'm the only one feeling a bit lost.

from docs.

Frijol avatar Frijol commented on July 21, 2024

right with you @danielkhan on feeling a bit lost!

from docs.

Qard avatar Qard commented on July 21, 2024

A lot of the discussions around technical ideals for the docs structure and design have referenced the Rust and Django docs. Those are good places to look for what we think are docs done right.

from docs.

mikeal avatar mikeal commented on July 21, 2024

Frankly, I think this repo has been way too focused on tooling when what we really need is content.

If the current tool isn't finished I think the simplest one imaginable should be created and we should start doing outreach focused on building and improving content which is visible on the website. Tooling can be improved later, the important part is building a community around created and improving the content.

from docs.

Qard avatar Qard commented on July 21, 2024

👍 More content is exactly what I want to see.

from docs.

mikeal avatar mikeal commented on July 21, 2024

Can someone tell me the state of this repo/project? It seems like it's just a bunch of empty directories?

I'm concerned because there's a ton of people trying to do things in Issues with no real path to getting anything done. Documentation is becoming an increasingly hot topic and it seems like the undefined state of this WG is holding back contributions.

from docs.

Qard avatar Qard commented on July 21, 2024

Agreed. It seems there needs to be some coordination with the website wg to get this stuff online, but that's just not happening, for some reason. There also hasn't been a meeting in awhile, which needs to change.

from docs.

bengl avatar bengl commented on July 21, 2024

This repo has a README now so closing this. @Frijol since you expressed interest in helping out, please have a look here: nodejs/node#4573

from 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.