Code Monkey home page Code Monkey logo

Comments (2)

tmeasday avatar tmeasday commented on August 26, 2024

There's also this section: http://guide.meteor.com/#guide-concepts

I agree completely with you. I realised this was a problem as I wrote the docs/Contributing.md file but I wanted to make sure we had something up before we posted the blog post. I think we can rationalize this a lot a make it easier to navigate.

In terms of the best execution of this, I think there are two things that are common and perhaps best not duplicated:

  • Overall "contributing to meteor documentation in general" document (currently docs/Contributing.md)
  • Overall "meteor documentation style" which is probably more or less current guide/Contributing.md.

I agree everything is simple enough that it's not worth both projects having separated readmes / contributing files. Perhaps it's best to just have:

  • docs/README:
    • link to docs / 1 line description [ALSO add a section to docs/index.html analagous to http://guide.meteor.com/#guide-concepts]
    • how to run locally
    • meteor documentation style
    • becoming a docs contributor
  • guide/README:
    • link to guide / 1 line description
    • how to run locally
    • [LINK TO DOCS]: meteor documentation style
    • [LINK TO DOCS]: becoming a docs contributor

from docs.

filipenevola avatar filipenevola commented on August 26, 2024

I'm closing this issue because it's too old.

If you think this issue is still relevant please open a new one.

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.