Feat/docs

[eduardconstantin]

Which issue(s) does this pull-request address?

Closes: #74

Description

Added index.html to docs folder to render documentation using docsify. Added Readme.md as homepage. Added _sidebar.md to have a custom sidebar. This are the deployment steps from docsify docs: https://docsify.js.org/#/deploy

Checklist

• [x] I have read the contributor guide
• [x] Linting passes: yarn lint or yarn lint:fix
• [x] Formatting is applied: yarn format or yarn format:fix
• [x] Unit tests pass: yarn test:unit
• [x] E2E tests pass: yarn test:e2e
• [ ] Tests are included
• [x] Documentation is changed or added
• [x] Commit messages and PR title follow conventional commits

[eduardconstantin]

@Tomas2D I added the action, I used this: https://github.com/marketplace/actions/docsify-action?version=v1.1 I also updated the sidebar Also could you add the hacktoberfest label to the pr?

[eduardconstantin]

ensures that formatting [!NOTE] / [!TIP] and renders correctly because, from the provided screenshots, it does not.

it seems that docsify needs pulgins to format different tags

[eduardconstantin]

Note: the hacktoberfest label is attached to the related issue; isn't that sufficient?

You will have to add it to the PR too and me as the asignee.

[eduardconstantin]

• [ ] It makes sense to leverage https://github.com/docsifyjs/docsify-cli so we could develop the docs in the watch mode (update docs:build script and add docs:watch) - I added the docs:watch script, I don't know what to add to build
• [ ] auto copy README.md to docs/README.md as part of the docs:build - The links insed the readme file needs to be changed once the file is copied to the docs folder, but this step happened during docsify init command, if you call this command it will override the readme.md and index.html files (the index now has plugins added inside)
• [x] ensures that all code snippets are rendered correctly
• [x] ensures that all links will point to the https://i-am-bee.github.io/bee-agent-framework/ (if not developed locally)
• [x] ensures that formatting [!NOTE] / [!TIP] and renders correctly because, from the provided screenshots, it does not.
• [x] ensures that pipelines are passing (DCO / Lints)

[Tomas2D]

I added the docs:watch script, I don't know what to add to build

docsify generate ?

[eduardconstantin]

I added the docs:watch script, I don't know what to add to build

docsify generate ?

this command only generates the _sidebar.md file

if I add the init command it will override the index and the readme

[eduardconstantin]

This signing-off thing is awful

[eduardconstantin]

Also fixed the rest of the issues

[eduardconstantin]

oh, yeah, sorry

[eduardconstantin]

I tried with this command but I get conflicts from your commits git rebase -i HEAD~47

[Tomas2D]

No problem, I will do it by myself. Thank you for your contribution.