GithubHelp home page GithubHelp logo

Comments (8)

kuldeepsidhu88 avatar kuldeepsidhu88 commented on September 4, 2024

@authorjapps I am interested to take this. I will add more details after some investigation in few days.

from zerocode.

authorjapps avatar authorjapps commented on September 4, 2024

@kuldeepsidhu88 , thanks. Please proceed.
You can assign this ticket to yourself and let me know in case you need any help.

from zerocode.

kuldeepsidhu88 avatar kuldeepsidhu88 commented on September 4, 2024

@authorjapps
Most of the open source projects are using below two tools for documentation. Feature wise both seems to be good, and have global search available which can search through all pages.

Gitbook https://www.gitbook.com/
Examples
OpenRewrite
Synk
Thunderbird
Portainer

Docusaurus https://docusaurus.io
Examples
Ionic Framework
JestJS
Supabase

Please let me know which one seems to be good fit. I would be happy to contribute in the migration.

from zerocode.

vimalJD avatar vimalJD commented on September 4, 2024

Is this project is ongoing? Let me know further (DOCS) to contribute on it as "good first issue".

from zerocode.

authorjapps avatar authorjapps commented on September 4, 2024

@vimalJD , this is still pending. Thanks for your interest.
Can you attach a POC or a demo how the UI will look? For this you can host it in GitHub for free.

That will help to finalize the theme and then we can host it.

Suggest couple of options for selecting the theme

The idea here is : the text or code on any of the Wiki pages should be searchable for the end-user convinience.


For creating the demo:

You can pick this :

Docusaurus https://docusaurus.io/

and create something like:
https://ionicframework.com/docs/ <--- Give a search and see. Docs are easily searchable.

Please ask for help here by tagging @authorjapps or @kuldeepsidhu88 when desired. 🤝

from zerocode.

authorjapps avatar authorjapps commented on September 4, 2024

Assigned to @nirmalchandra to pick this

from zerocode.

nirmalchandra avatar nirmalchandra commented on September 4, 2024

Created a draft version here:
https://github.com/authorjapps/zerocode/tree/doc_branch#documentation
(Click the link under this section)

Looking for a free hosting provider.
Trying GitHub Pages in the mean time.

from zerocode.

authorjapps avatar authorjapps commented on September 4, 2024

Documentation link is here:
https://github.com/authorjapps/zerocode/tree/master?tab=readme-ov-file#documentation

Note:
Contribution options and steps are mentioned in the above section.

from zerocode.

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.