search

aleph-im / aleph-docs

Aleph.im Official Documentation (Work in progress)
https://docs.aleph.im/
MIT License
6 stars 8 forks source link

Execute code #83

Closed leirbag95 closed 3 months ago

leirbag95 commented 3 months ago

Upload / Write code documentions

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

leirbag95 commented 3 months ago

Thanks for these additions !

I would like to discuss two points regarding the language used:

  1. The use of we is not consistent with the rest of the documentation. The rest of the documentation speaks about "the platform", "aleph.im", ... but not "we" or "us".
  2. Some sentences include superlative that do not bring anything to the reader, such as "You will be able to easily integrate your projects and get them running smoothly."

Can we discuss how to ensure that the documentation is consistent regarding the language used ?

I've made adjustments to the text by removing references to the second-person plural, opting instead for a broader, more impersonal style. Additionally, I've cut out extraneous content that didn't add value, streamlining the message for better clarity and focus.

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

MHHukiewitz commented 3 months ago

This conversation reads like it has been written by ChatGPT :'D

MHHukiewitz commented 3 months ago

I'd rename it to "Web Console", so it is clear that not the CLI is being meant here

leirbag95 commented 3 months ago

This conversation reads like it has been written by ChatGPT :'D

I take it as a compliment ^^

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

MHHukiewitz commented 3 months ago

Just discussing the Node.js example with @philogicae, as it does not yet seem to work as described in the docs. Should we postpone merging this until we clear up the situation? Or split it out into its own PR so we can describe the Python process for now?

philogicae commented 3 months ago

Just discussing the Node.js example with @philogicae, as it does not yet seem to work as described in the docs. Should we postpone merging this until we clear up the situation? Or split it out into its own PR so we can describe the Python process for now?

Yes, this is not ready yet. If users are actually following the docs, it will not work. I will speak with @leirbag95 to fix it

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

github-actions[bot] commented 3 months ago

Deployed (not pinned) on:

philogicae commented 3 months ago

LGTM, we can merge. Fixing JS functions is still in WIP: There is an incorrect linking of package dependencies. They should be uploaded and referenced as an immutable volume and mapped on /opt/node_modules. ATM, users are required to include the node_modules folder inside its code folder. We will have to update the docs again later when the fix will be deployed and tested.