search

aleph-im / aleph-docs

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

55 refactor posts part of the documentation #59

Closed Antonyjin closed 4 months ago

Antonyjin commented 4 months ago

Refactoring the posts part of the documentation.

Splitting main points to make it more clear.

github-actions[bot] commented 4 months ago

Deployed (not pinned) on:

github-actions[bot] commented 4 months ago

Deployed (not pinned) on:

github-actions[bot] commented 4 months ago

Deployed (not pinned) on:

github-actions[bot] commented 4 months ago

Deployed (not pinned) on:

Antonyjin commented 4 months ago

I created them manually using the data tables in mkdocs : https://squidfunk.github.io/mkdocs-material/reference/data-tables/

For the error page, I thought I'd done it. It was a matter of calling get_messages() and get_messages_error() to find out the status of a request and, in the event of a problem, to have logs about it.

github-actions[bot] commented 4 months ago

Deployed (not pinned) on:

github-actions[bot] commented 4 months ago

Deployed (not pinned) on:

github-actions[bot] commented 4 months ago

Deployed (not pinned) on:

Antonyjin commented 4 months ago

As a reminder, this PR was originally intended to re-document the Post method.

I've just completed the rebasing with the main branch and written the explanation of the error page.

What do you think of this version?

I'm sorry, it's a huge PR with lots of changes, so it might be complicated to review. Hugo has already told me to make more small PRs that could be reviewed more easily. I'm all for doing that and will do it for my next PRs.

MHHukiewitz commented 4 months ago

The Error section looks good, but it would be even greater if we could list some of the common errors. For that, you could look into the pyaleph code to find a list of error codes.

About the size, I don't mind that much. I'll try to review the pages that were changed in the preview and if they read well, I approve.

Antonyjin commented 4 months ago

This is a great idea, I'm going to do that!

github-actions[bot] commented 4 months ago

Deployed (not pinned) on:

Antonyjin commented 4 months ago

I've created a table with all the error codes instead of just a few. I find it more complete and the display is very nice.

What do you think?