List of ideas

[viferga]

We have done a talk about the tutorials and the documentation and we have written some ideas about how to proceed or suggestions about possible projects that can be done.

TODO: I am going to paste it here and I will elaborate them as soon as I can.

• Build the doc template
• Create a list with different ideas for the doc and tutorials
• Local playground for testing things
• Tutorials -> For deploying into metacall
• Tutorials -> For showing polyglot capabilities
• Tutorials -> Both previous ideas
• GPT bot trained with the documentation

[MoX678]

will work in the doc template project
here is the link for what i will do and will update as my work go
#2

[viferga]

The idea of the documentation is to show the complete workflow of metacall.

MetaCall right now is a CLI that includes deploy and faas tools, apart from the REPL.

So basically we have 4 modes:
metacall script.js
metacall // REPL
metacall deploy
metacall faas

The ideal would be to show the complete workflow, form developing locally, testing, deploying in local mode, and then deploy in the production faas: #5 (comment)

This should show the workflow for developing any polylgot application.

Apart from this, we can add as much tutorials or examples as we want. Even future examples or projects that are half done, and later on we can complete them, for example: https://github.com/metacall/vscode-extension

For the browser playground we can add this: https://github.com/copy/v86

[viferga]

Respect to the review, it is important that we do not have photos of code, never. It should be always in a copy-able format.

[viferga]

In the readme we should add how to develop and any coding conventions that we are using in this project (for example, not using images of code, always using Markdown if possible and use the minimum HTML when possible). We have to show how to develop and test the project locally.

[viferga]

We have to describe the whole community, how it works, how it is linked, the links to all the social networks. Also GSoC, how to contribute in general.

[viferga]

The last part we can do is maybe unify a bit the C/C++ documentation of the Core with this one, but in my opinion I would like to make it apart from this. Maybe it will be interesting if we show it as compiling for the end user usage, instead of developer usage.