Update documentation and update links #15
Conversation
Deploying meower-docs with
|
| Latest commit: |
ee759c7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d32b7c27.meower-docs.pages.dev |
| Branch Preview URL: | https://showier-update.meower-docs.pages.dev |
There was a problem hiding this comment.
What's the point of this file? Shouldn't this documentation be for the Meower API, not the features Meower has?
There was a problem hiding this comment.
No other place to put it in the docs. Its could be considered a semi index for where stuff is as it gets documented
There was a problem hiding this comment.
What's the point of it in the first place, though? How does it make the documentation better? People reading the Meower docs probably already know which features Meower has
There was a problem hiding this comment.
the client requirements where the only place it existed before. So it needs to be here instead. This is especially needed for new client devs that cant read python/golang
There was a problem hiding this comment.
So it needs to be here instead. This is especially needed for new client devs that cant read python/golang
Meower Svelte and others exist. People can see the features Meower has from there. Specific implementation details (i.e. API endpoints) is what the docs would be for
There was a problem hiding this comment.
yes but that still requires reading source code. It's slightly better to have them listed out somewhere
There was a problem hiding this comment.
Listing the API endpoints is the entire point of the docs, doesn't need its own file
| | mod_deleted | boolean | Whether the post was deleted by a moderator. | ✓ | | ||
| | deleted_at | integer | The post's deletion timestamp in Unix seconds. | ✓ | | ||
| <!-- deno-fmt-ignore-start --> <!-- Uploads was down --> | ||
| | Field | Type | Description | Optional | |
There was a problem hiding this comment.
Could this be formatted the way all the other tables are?
There was a problem hiding this comment.
no, it's unreadable and uneditable otherwise
There was a problem hiding this comment.
How? Also, that's what the rest of the tables do, it should really be consistent
There was a problem hiding this comment.
I had to format it with a vscode ext so I could actually edit it
There was a problem hiding this comment.
(tried to do it with 1 other but the ext failed to format that one)
There was a problem hiding this comment.
I really don't see what you mean
"Formatted"
Current
There was a problem hiding this comment.
Meaning it looks worse with line wrapping because it adds an extra line inbetween lines
There was a problem hiding this comment.
Even without word wrapping (but especially with word wrapping which is pretty much necessary for md files), the current is way easier to read and has more information on screen
"Formatted"
"Current"
There was a problem hiding this comment.
there's no reason for this, especially if you're not adding it to the sidebar. the api reference (/api/rest) should be sufficient once the openapi schema is updated to have actual descriptions and names for the endpoints
There was a problem hiding this comment.
once the openapi schema is updated to have actual descriptions and names for the endpoints
Is this planned? That would leave the REST-API section pretty much useless
There was a problem hiding this comment.
Is this planned? That would leave the REST-API section pretty much useless
yes. we'd like to eventually improve the autogenerated documentation, but there're limitations w/what we can have them display which would probably keep the handwritten docs around
There was a problem hiding this comment.
That was very overwhelming tbf
| <!-- deno-fmt-ignore-start --> | ||
|
|
||
| | Field | Type | Description | | ||
| | - | - | - | | ||
| | _id | string | The emoji's UUID4. | | ||
| | animated | boolean | Whether the emoji is animated. | | ||
| | chat_id | UUID4 | The chat's UUID4. | | ||
| | name | string | The emoji's name. | | ||
|
|
||
| <!-- deno-fmt-ignore-end --> |
There was a problem hiding this comment.
| <!-- deno-fmt-ignore-start --> | |
| | Field | Type | Description | | |
| | - | - | - | | |
| | _id | string | The emoji's UUID4. | | |
| | animated | boolean | Whether the emoji is animated. | | |
| | chat_id | UUID4 | The chat's UUID4. | | |
| | name | string | The emoji's name. | | |
| <!-- deno-fmt-ignore-end --> | |
| <!-- deno-fmt-ignore-start --> | |
| | Field | Type | Description | | |
| | - | - | - | | |
| | _id | string | The emoji's UUID4. | | |
| | animated | boolean | Whether the emoji is animated. | | |
| | chat_id | UUID4 | The chat's UUID4. | | |
| | name | string | The emoji's name. | | |
| <!-- deno-fmt-ignore-end --> |
please be consistent w/formatting the ignore blocks
There was a problem hiding this comment.
please change table formatting to match the other existing files and remove the comment about uploads being down
| } | ||
| ``` | ||
|
|
||
| #### Livechat | ||
| #### Livechat (outdated) |
There was a problem hiding this comment.
for this and the other instances of things being marked as outdated, could you please actually update the examples
No description provided.