Code Monkey home page Code Monkey logo

Comments (5)

josegonzalez avatar josegonzalez commented on May 26, 2024

I recommend using readthedocs.org. Would you like me to make a pull request with this change? It will require moving to rst for documentation...

from goiardi.

spheromak avatar spheromak commented on May 26, 2024

as long as you can keep the GODOC also in play. Probably want to make some Doc specific to Godoc, and some user specific stuff.

from goiardi.

ctdk avatar ctdk commented on May 26, 2024

@josegonzalez Checking that out right now.

@spheromak I was planning on keeping the godocs around, certainly. Even now the README and the godoc docs aren't drawn from the same place; doc.go and README.md have basically the same content, but I still have to keep them synced by hand.

from goiardi.

ctdk avatar ctdk commented on May 26, 2024

@josegonzalez Looks good. I don't mind moving to rst for documentation at all; the godocs are their own thing and can change to be more focused on internals rather than being a mirror of the README. (The subdirectory godocs are already internally focused anyway, so that would fit better.)

from goiardi.

josegonzalez avatar josegonzalez commented on May 26, 2024

:)

from goiardi.

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.