Better organise the documentation, document the policy engine, the authorisation process and the scopes #2637
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying matrix-authentication-service-docs with
|
| Latest commit: |
e887cd2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://86efcc62.matrix-authentication-service-docs.pages.dev |
| Branch Preview URL: | https://quenting-api-docs.matrix-authentication-service-docs.pages.dev |
sandhose
force-pushed
the
quenting/api-docs
branch
from
a53b6d6
to
e367e1a
Compare
gabreal
reviewed
Apr 24, 2024
sandhose
force-pushed
the
quenting/api-docs
branch
from
b278ce4
to
31a8add
Compare
sandhose
changed the title
wrjlewis
reviewed
May 3, 2024
| @@ -5,7 +5,13 @@ This documentation is intended to give an overview of how the `matrix-authentica | |||
| The documentation itself is built using [mdBook](https://rust-lang.github.io/mdBook/). | |||
There was a problem hiding this comment.
After the first sentence in the readme, would it be worth adding what MAS actually is, in a short sentence?
There was a problem hiding this comment.
I just added a few words, mostly copied from the repo README 👍
| - [`manage`](./reference/cli/manage.md) | ||
| - [`server`](./reference/cli/server.md) | ||
| - [`templates`](./reference/cli/templates.md) | ||
| - [`doctor`](./reference/cli/doctor.md) | ||
|
|
||
| # Development | ||
|
|
There was a problem hiding this comment.
Should the 'Application Services login' be under a section? Feels like a bit of an orphan at the moment
There was a problem hiding this comment.
It is indeed a bit lonely, its main purpose is to have a link from the README to have a disclaimer on the state of ASes. I think I'll leave it as-is for now
Co-authored-by: Will Lewis <1543626+wrjlewis@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a few section to the documentation:
Fixes #2187
Part of #2605
This also reorganises the documentation to have basically 4 parts:
I also want to add more "how-to" tutorials, really task-oriented, but I'll add some of them in another PR.