make documentation on how to use hero (mdbook) #7

New Issue

sashaastiadi · 2024-03-27T12:47:01Z

sashaastiadi commented

2024-03-27 12:47:01 +00:00

step by step procedure for people to be able to create their won mdbook and preview locally
written for readme + manual info_grid collaboration tool page
step by step from installing hero to previewing mdbook locally

- [x] step by step procedure for people to be able to create their won mdbook and preview locally - [x] written for readme + manual info_grid collaboration tool page - [x] step by step from installing hero to previewing mdbook locally

sashaastiadi changed title from ~~make documentation on how to us ehero (mdbook)~~ to make documentation on how to use hero (mdbook)

2024-03-27 12:47:17 +00:00

sashaastiadi added this to the Web_TODOS project 2024-03-27 13:01:06 +00:00

scott was assigned by sashaastiadi

2024-03-27 13:01:16 +00:00

mik-tf was assigned by sashaastiadi

2024-03-27 14:49:29 +00:00

scott was unassigned by sashaastiadi

2024-03-27 14:49:32 +00:00

mik-tf commented

2024-03-27 15:29:05 +00:00

Currently discussing with Mario Bassem (not sure if he's on git.ourworld.tf) on how to properly set hero.

Once this is figured out, I can work on the guide.

Most of the info is already written in this docs: https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_fullvm.md

Currently discussing with Mario Bassem (not sure if he's on git.ourworld.tf) on how to properly set hero. Once this is figured out, I can work on the guide. Most of the info is already written in this docs: https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_fullvm.md

mik-tf commented

2024-03-29 17:19:38 +00:00

Work done here: https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_fullvm.md

hero was fixed this week by mario and thanks to sasha for some outputs too, now the docs is easy to follow and works on the grid. So anyone can deploy hero knowing it will work.

Work done here: https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_fullvm.md hero was fixed this week by mario and thanks to sasha for some outputs too, now the docs is easy to follow and works on the grid. So anyone can deploy hero knowing it will work.

mik-tf commented

2024-03-29 17:20:29 +00:00

Next week I will write a guide on how to make a book. So will give a book template more or less, with proper info in /docs

Karoline888 commented

2024-04-01 08:07:37 +00:00

Hey Team
Just sharing that I saw an add for https://scribehow.com/ yesterday, maybe this or some other AI powered tool could speed up our manual creation.. ?
Maybe you also already use something? Smart of you then!
Many blessings!

Hey Team Just sharing that I saw an add for https://scribehow.com/ yesterday, maybe this or some other AI powered tool could speed up our manual creation.. ? Maybe you also already use something? Smart of you then! Many blessings!

mik-tf commented

2024-04-02 03:21:12 +00:00

Thanks for sharing @Karoline888

It seems that to have scribehow to be useful, you"d need a paid plan:

I am not sure TF wants to put money into this right now. Not sure also if it provides something we can't do currently.

Also, we have dashboard tour with tourguide JS feature being worked on in this issue: https://github.com/threefoldtech/tfgrid-sdk-ts/issues/736

Basically tourguide JS is used to create videos similar to what scribehow proposes: https://tourguidejs.com/#guide

Do you have some feature in mind that scribehow has which we should use? In this case please let us know, then we could surely create/reproduce such features within TF with open-source alternatives.

Thanks for sharing @Karoline888 It seems that to have scribehow to be useful, you"d need a paid plan: ![image](/attachments/ac9a6597-9d3c-4fc4-9921-e92987adf127) I am not sure TF wants to put money into this right now. Not sure also if it provides something we can't do currently. Also, we have dashboard tour with tourguide JS feature being worked on in this issue: https://github.com/threefoldtech/tfgrid-sdk-ts/issues/736 Basically tourguide JS is used to create videos similar to what scribehow proposes: https://tourguidejs.com/#guide Do you have some feature in mind that scribehow has which we should use? In this case please let us know, then we could surely create/reproduce such features within TF with open-source alternatives.

image.png

111 KiB

👍 1

Karoline888 commented

2024-04-02 06:31:56 +00:00

Ok maybe for now not too necessary but good to keep in the back of our head :-)

mik-tf commented

2024-04-02 19:33:22 +00:00

The docs folder of info_tfgrid contains all necessary information to:

install and set hero, crystallib and V
create a new mdbook from scratch
preview mdbook locally or from a remote repository

The docs folder of info_tfgrid contains all necessary information to: - install and set hero, crystallib and V - create a new mdbook from scratch - preview mdbook locally or from a remote repository

mik-tf closed this issue

2024-04-02 19:33:22 +00:00

Sign in to join this conversation.