Coder Social home page Coder Social logo

start a userguide about gokrazy HOT 5 OPEN

gokrazy avatar gokrazy commented on June 9, 2024 4
start a userguide

from gokrazy.

Comments (5)

prologic avatar prologic commented on June 9, 2024

I was going to suggest; why not just use the built-in Wiki? I'd even be happy to contribute; although I haven't used gokrazy all that much to be honest (yet)

from gokrazy.

stapelberg avatar stapelberg commented on June 9, 2024

I’ll think about it. In general, I like having the documentation on the proper website, but perhaps the wiki is a more pragmatic solution.

from gokrazy.

prologic avatar prologic commented on June 9, 2024

Yeah I tried that once myself with one of my projects with the whole Github Pages thing and found it too much work to maintain and get it looking nice. The Builtin Wiki is definately more convenient I think in this case plus you can contribute to it like any other repo.

from gokrazy.

stapelberg avatar stapelberg commented on June 9, 2024

I’ve come to really like the editing experience with https://gohugo.io/, and have used it successfully for https://distr1.org/.

The distri website sources are located in https://github.com/distr1/distri/tree/master/website and instruct hugo to render to the https://github.com/distr1/distri/tree/master/docs subdirectory, which is then picked up by GitHub pages.

I think we can do the same thing here, i.e. convert https://github.com/gokrazy/gokrazy.github.io to a hugo instance which renders to the docs/ subdirectory and then serve that. Shouldn’t be too involved.

from gokrazy.

stapelberg avatar stapelberg commented on June 9, 2024

Okay, the userguide is now started at https://gokrazy.org/userguide/, and contributions of the remaining topics (see first comment of this issue) are welcome! Please comment here when you start working on a topic so that others don’t accidentally duplicate your work.

from gokrazy.

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.