docs: add first documentation archetype. #957

ajnavarro · 2023-07-07T10:04:58Z

Adding different concepts linked between them as a first iteration to keep adding new and deeper ones to our documentation.

Related issues and PRs:

Contributors Checklist

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

Adding different concepts linked between them as a first iteration to keep adding new and deeper ones to our documentation. Signed-off-by: Antonio Navarro Perez <[email protected]>

thehowl · 2023-07-07T12:26:36Z

docs/daos.md

+---
+
+# DAOs
+Decentralized Autonomous Organizations are represented as a group of [Realm](./realm.md)s or/and [package](.)s that can manage decisions using the blockchain. We have several DAOs that will be in charge of:


Mmh, it's actually people, no? I see it as decision-making regulated through code

thehowl · 2023-07-07T12:28:58Z

docs/gnovm.md

+
+# Gnovm
+
+Gnovm is in charge to run [Gno](.) code. It interprets directly the source code and parses it to an AST. After that, it emulates CPU instructions to execute the AST instead of executing it directly. It is able to store the state of a [Realm](./realm.md) and retrieve it on the next execution.


it emulates CPU instructions to execute the AST instead of executing it directly

unclear; I would suggest something like "interprets the AST to execute its code, similarly to Python, in contrast to executing machine code directly, like Go with the official compiler".

I propose(combines discussion above): "Gnovm is in charge to run Gno code. Firstly, Gno source code is parsed into an Abstract Syntax Tree (AST). Then, Gnovm interprets the AST to execute the code. This process bears similarity to Python's execution model, which contrasts with that of Go's official compiler that directly executes machine code..."

I would suggest something like "interprets the AST to execute its code, similarly to Python, in contrast to executing machine code directly, like Go with the official compiler".

I would prefer to explain things as they are instead of using other languages as examples. Some people might not know how Python interpreter works.

edit: where are we talking in your rewordings about OP codes? we are not just executing the AST but generating a list of OP codes that will be executed.

thehowl · 2023-07-07T12:33:10Z

docs/gnoweb.md

+
+gnoweb is an application that can call a special method on a [realm](./realm.md) that returns markdown as the output. This can be used to create any kind of web interface, like social networks, blog systems, forums, or standard status pages.
+
+The method that it calls is `Render(string)`string` where the input string is a path, and the output string is markdown.


Suggested change

The method that it calls is `Render(string)`string` where the input string is a path, and the output string is markdown.

The method that it calls is `Render(string) string` where the input is a path (to discriminate different requests, and potentially handle them through a router), and the return value is markdown to be rendered.

I would also add something like:

It has read-only access also to the [Realm State](./realm-state.md), so it can serve as a useful bridge between web2 and content on web3.

Just a note that the output of Render does not have to be markdown specifically

zivkovicmilos

I like this as a starting point for our official docs, that will incorporate these very documents somehow

Left a few super minor comments, otherwise it looks good for the base version that will get expanded 💯

zivkovicmilos · 2023-07-07T12:44:36Z

docs/daos.md

@@ -0,0 +1,9 @@
+---
+state: design # Nothing implemented yet, figuring out the best way to do it.


What kinds of states do we have in total?

right now, 3:

improvements-needed: The final PoC is working well, but it must evolve performance-wise.

design: Nothing implemented yet, figuring out the best way to do it.

done: it is done (nothing yet)

docs/gnode.md

zivkovicmilos · 2023-07-07T12:46:27Z

docs/gnoweb.md

+
+gnoweb is an application that can call a special method on a [realm](./realm.md) that returns markdown as the output. This can be used to create any kind of web interface, like social networks, blog systems, forums, or standard status pages.
+
+The method that it calls is `Render(string)`string` where the input string is a path, and the output string is markdown.


Just a note that the output of Render does not have to be markdown specifically

docs/ibc-protocol.md

docs/new-tendermint.md

Signed-off-by: Antonio Navarro Perez <[email protected]>

thehowl · 2023-09-07T16:46:31Z

Superseded by #1046

Docs: Add first documentation archetype.

62a6d02

Adding different concepts linked between them as a first iteration to keep adding new and deeper ones to our documentation. Signed-off-by: Antonio Navarro Perez <[email protected]>

ajnavarro requested a review from a team as a code owner July 7, 2023 10:04

github-actions bot assigned ajnavarro Jul 7, 2023

ajnavarro changed the title ~~Docs: Add first documentation archetype.~~ docs: Add first documentation archetype. Jul 7, 2023

thehowl reviewed Jul 7, 2023

View reviewed changes

zivkovicmilos approved these changes Jul 7, 2023

View reviewed changes

harry-hov changed the title ~~docs: Add first documentation archetype.~~ docs: add first documentation archetype. Jul 7, 2023

Requested changes

7ba8cfc

Signed-off-by: Antonio Navarro Perez <[email protected]>

thehowl closed this Sep 7, 2023

thehowl mentioned this pull request Sep 7, 2023

Minutes: GitHub Review Meetings [every Thursday] gnolang/meetings#18

Open

3 tasks

moul added this to the 🌟 main.gno.land (wanted) milestone Sep 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add first documentation archetype. #957

docs: add first documentation archetype. #957

ajnavarro commented Jul 7, 2023 •

edited

Loading

thehowl Jul 7, 2023 •

edited

Loading

thehowl Jul 7, 2023

ltzmaxwell Jul 8, 2023

ajnavarro Jul 10, 2023 •

edited

Loading

thehowl Jul 7, 2023

zivkovicmilos Jul 7, 2023

zivkovicmilos left a comment

zivkovicmilos Jul 7, 2023

ajnavarro Jul 10, 2023

zivkovicmilos Jul 7, 2023

thehowl commented Sep 7, 2023


		# Gnovm

		Gnovm is in charge to run [Gno](.) code. It interprets directly the source code and parses it to an AST. After that, it emulates CPU instructions to execute the AST instead of executing it directly. It is able to store the state of a [Realm](./realm.md) and retrieve it on the next execution.


		gnoweb is an application that can call a special method on a [realm](./realm.md) that returns markdown as the output. This can be used to create any kind of web interface, like social networks, blog systems, forums, or standard status pages.

		The method that it calls is `Render(string)`string` where the input string is a path, and the output string is markdown.

		@@ -0,0 +1,9 @@
		---
		state: design # Nothing implemented yet, figuring out the best way to do it.

docs: add first documentation archetype. #957

docs: add first documentation archetype. #957

Conversation

ajnavarro commented Jul 7, 2023 • edited Loading

Contributors Checklist

thehowl Jul 7, 2023 • edited Loading

Choose a reason for hiding this comment

thehowl Jul 7, 2023

Choose a reason for hiding this comment

ltzmaxwell Jul 8, 2023

Choose a reason for hiding this comment

ajnavarro Jul 10, 2023 • edited Loading

Choose a reason for hiding this comment

thehowl Jul 7, 2023

Choose a reason for hiding this comment

zivkovicmilos Jul 7, 2023

Choose a reason for hiding this comment

zivkovicmilos left a comment

Choose a reason for hiding this comment

zivkovicmilos Jul 7, 2023

Choose a reason for hiding this comment

ajnavarro Jul 10, 2023

Choose a reason for hiding this comment

zivkovicmilos Jul 7, 2023

Choose a reason for hiding this comment

thehowl commented Sep 7, 2023

ajnavarro commented Jul 7, 2023 •

edited

Loading

thehowl Jul 7, 2023 •

edited

Loading

ajnavarro Jul 10, 2023 •

edited

Loading