Git Product home page Git Product logo

Comments (2)

hackrush01 avatar hackrush01 commented on May 24, 2024

From slack DM

ok here's how i think it should work
we need to require mkdocs as a dev requirement
then we should run the gen_api_docs script and have it generate the markdown files into a temp directory
then run mkdocs build to build the html and put it into /docs
this should all happen by running a single script
so maybe that can be the last step of gen_api_docs
so /docs gets checked into git, but the intermediate dir with the markdown files does not
then, as part of travis's tests, travis should call the gen_api_docs script and check if the /docs dir has any changes in it
if it does, travis should fail the build and print a message like "run gen_api_docs and commit the changes"
this way, docs changes always go in the same PR as code changes
they get merged together
nothing is out of sync
and we can server https://lbryio.github.io/lbry/ out of the docs dir
as soon as the code is pushed, the online docs will update
now IDEALLY, the docs should be versioned just like the daemon is versioned, so they match our releases. but that's for another time

from grooming.

alyssaoc avatar alyssaoc commented on May 24, 2024

closed in favor of lbryio/lbry-sdk#1132

from grooming.

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.