openfga / openfga.dev Goto Github PK

In https://openfga.dev/docs/modeling/getting-started#02-list-the-object-types, the objects are not highlighted in blue. It is displayed as normal text instead.

Some expandable sections in the docs that have isolated codeblocks appear to have extra padding above and below the codeblocks. These might look better if they have consistent padding (eg, 1rem on all sides).

Currently, we use a temporary swagger file as place holder. We need to update docusaurus.config.js to point to the correct swagger file.

Note that the new swagger file's tag is different. This means we will need to update the swagger file + call to /api/service for the correct API.

For landing page's resource section, we should update the links

1. Instead of Spotify - Authorization in Software → and Apple - Authorization in Software →, use https://authorizationinsoftware.auth0.com/
2. Add in link for Auth0 FGA playground

Should link to https://github.com/orgs/openfga/projects/1 instead of https://github.com/orgs/openfga/projects

Pull request from non openfga repo did not trigger github check action. Consequently, Run Checks, markdown-link-check and markdown-link-check-md did not run and is stale.

Table of content in the right sidebar has incorrect styling.
The visited link, instead of current section, show as green color.

Use the published npm from https://github.com/openfga/syntax-transformer instead of doing our own transformation. This also involves updating the syntax name to a cleaner name.

Currently, after each push to main, the github page's CNAME is lost and require manual re-add.

As a user reading snippets of the OpenFGA domain specific language, I want syntax highlighting to help me learn and differentiate between system words (type/relations/define/self/as/from/and/or/but/not) and user words.

Current state:

Current:

🕵️ 🕵️ 🕵️

🕵️ 🕵️ 🕵️

This is probably my fault in some way, I'll fix it.

The styling and color (green) for "Get Involved" heading suggests that it is a clickable link. Either update color or add a proper link to it.

Currently, clicking on breadcrumb will not lead you to the section. Root cause is that the overview file exists as a separate page instead of embedded them in the category.

👀

These endpoints should have the same styling as the others, at least, for consistency's sake.

We probably need to add something like:

<meta name="viewport" content="width=device-width, initial-scale=1">

The "Details" and "Summary" section seems to have incorrect stying

In mobile browser (happened with both iPhone 12 and Samsung s20), the search bar resizes when clicking on it initially. This happens on both landing page as well as docs page search bar.

See following video capture:

The following link in landing page should point to https://github.com/openfga

If playground banner is specified, the playground name is not included in the introduction section.

As a reader, I should be to have an easy remember address that link to the docs directly.

In mobile browser of dimension 360x670, clicking the menu button shows a dark screen with no text.

See screen capture below:

Previously, it is pointing to github.com/openfga/openfga

Fix documentation for the openfga configuration changed here: https://github.com/openfga/openfga/pull/75/files

The viewport bounces around when clicking through the tabbed code views:

See the following check

While we might want to put some thought into the overall design eventually, as a first step we could pad the Page Not Found message so that the error page feels like it follows the same conventions as the rest of the site's content.

The links in the doc's section's table of contents component have a conflicting style between '*--active' styling classes and ':hover' rules. This leads to a flash of white (the intended hover colour) before the link turns grey again.

While they might appear to be working properly at a glance, hovering your cursor for more than a few moments reveals the issue.

We currently use a basic SVG for the OpenFGA pattern, but have an animated video available.

Add in the video in the correct format/implementation with a fallback to the svg

For iPhone SE (375x667), the search bar covers part of the logo

See image below:

As a user, I want the url provided to resolve to the correct docker-compose file that will allow me to install OpenFGA

Current image:

The section "03-updating-the-authorization-model" has typo.
It should read plan:y instead of play:y.

Page https://openfga.dev/api/service does not scale well in mobile browser.

See following image for details.

This is left over from previous review.
Currently, configuration language page's equivalent zanzibar concepts section has a line
In the OpenFGA DSL, it would become:

However, the authorization model viewer below shows both DSL and JSON.
It will be better if we extend authorization model to allow specifying to show only either DSL or JSON.

The link https://openfga.dev// shows 404 page not found error.
Note that this may require a higher level fix than in Docusaurus as https://docusaurus.io// also fails.

Bad link for OpenFGA Configuration Language. Should point to /docs/configuration-language.

Prism log such as

PROISM <ref *1> {
  util: {
    encode: [Function: encode],
    type: [Function: type],
    objId: [Function: objId],
    clone: [Function: deepClone],
    getLanguage: [Function: getLanguage],
    setLanguage: [Function: setLanguage],
    isActive: [Function: isActive]
  },
...

is spawned during npm run build. Root cause is https://github.com/openfga/openfga.dev/blob/main/src/utils/prism-openfga-dsl.js#L20

As discussed in #58 (comment), we need to create raster image for metadata.

I looked deeper into the standard to refresh my memory, and it looks like [only raster images are supported](https://indieweb.org/The-Open-Graph-protocol#Does_not_support_SVG_images).

Maybe we should make another task for this, and I'll

make an image
place image in the right folder
add the appropriate og:image tag

The page setup-openfga has a table that does not fit into page width. Ideally, this should fit into page width

This page should be before after "Create a Store" and before "Update the Relationship Tuples".

Make sure it has the same model (i.e., with "reader", "writer" and "owner") as the "Update relationship tuples", "Perform a Check" and "Integrate within a Framework" pages.

🕵️ 😬

Should be

docker pull openfga/openfga
docker run -p 8080:8080 openfga/openfga run

to match with the changes in openfga's README

Since we are using custom domain instead of hosting page off https://openfga.github.io/, the baseURL will now be / instead of /openfga.dev/. We need to update build script to reflect this.

Clicking on heading will overshot and skip over the heading line. See below:

It is possible to have more than 1 store. Thus, the definition of store as defined in https://openfga.dev/docs/concepts#what-is-a-store is incorrect.

Currently, the table in https://openfga.dev/docs/getting-started/setup-openfga#configuring-the-server is coded statically. Ideally, this should be generated dynamically from the artifacts of https://github.com/openfga/openfga so that there is no mistmatch between the two.

There should be no analytics enabled.

Currently we have a placeholder description that will show up if someone copy/pastes the URL into Discord (and likely also in Twitter, Slack, etc).

We should audit this and craft the right meta data so that the project logo and description show up correctly.

Side note: the title is also repeating needlessly on the homepage.

The command curl -O https://openfga.com/docker-compose.yml needs to be changed to curl -O https://openfga.dev/docker-compose.yaml.

The playground pages should be removed. Instead, references should link directly to the playground pages.