Coder Social home page Coder Social logo

Comments (2)

rvs avatar rvs commented on August 18, 2024

Agreed @eriknordmark -- I think all the new docs for sure should go under top level docs. There may be things like design docs, etc. that only make sense at the pillar level -- but we don't have those yet, I think.

from eve.

rene avatar rene commented on August 18, 2024

I think this is not an issue anymore. Pillar, as all other packages under pkg/, has its own documentation inside his own folder (which makes sense). Although it could be not easy to find such documentation in the past, currently we have mkdocs in place, which considers all documentation files throughout the whole repository. For example, pillar documentation can be easily accessed through mkdocs (when they are generated), or even more quick by accessing the online version at https://eve-os.readthedocs.io/en/latest/pkg/pillar/

My vote is to close this issue.

FYI: @eriknordmark , @rouming

from eve.

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.