Make Zerocode Documentation content more searchable

[authorjapps]

AC1:

• Refer to other OSS projects on how it is done so
• List some links here for reference and their good features

AC2:

• Preferably use a OpenSource solution if available

AC3:

• Use GitHub hosting for initial setup, later switch to external hosting
  • e.g. docs.authorjapps.github.io or something similar for the initial setup

[kuldeepsidhu88]

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

[authorjapps]

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

[kuldeepsidhu88]

@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.

[vimalJD]

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

[authorjapps]

@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. 🤝

[authorjapps]

Assigned to @nirmalchandra to pick this

[nirmalchandra]

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.

[authorjapps]

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.