Skip to content

Updated developer docs#269

Merged
tuj merged 21 commits into
release/3.0.0from
feature/developer-docs
Sep 1, 2025
Merged

Updated developer docs#269
tuj merged 21 commits into
release/3.0.0from
feature/developer-docs

Conversation

@tuj

@tuj tuj commented Aug 29, 2025

Copy link
Copy Markdown
Contributor

Link to issue

#249

Description

  • Rewrite of developer docs.
  • Removed CLIENT_LOGGING environment variable since it has no effect.
  • Removed unused loginMethod.enabled field.
  • Fixed typo in .env variable APP_ACTIVATION_CODE_EXPIRE_INTERNAL to APP_ACTIVATION_CODE_EXPIRE_INTERVAL

Checklist

  • My code passes our continuous integration process.

@tuj tuj added this to the 3.0.0 milestone Aug 29, 2025
@tuj tuj self-assigned this Aug 29, 2025
@tuj tuj added the enhancement New feature or request label Aug 29, 2025
@tuj tuj changed the title Feature/developer docs Updated developer docs Aug 29, 2025
@tuj
tuj marked this pull request as ready for review August 30, 2025 08:59
@tuj tuj mentioned this pull request Aug 30, 2025
36 tasks
Comment thread Taskfile.yml
@@ -30,7 +30,6 @@ tasks:
- task compose-up
- task composer-install
- task db:migrate --yes

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we do an "if fixtures apply fixtures"?

@tuj tuj Sep 1, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra task for this

Comment thread Taskfile.yml
Comment thread UPGRADE.md Outdated

## 2.x -> 3.0.0

When upgrading from 2.x to 3.0.0 of OS2Display, a mayor change has been introduced to the project.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upgrading OS2Display from version 2.x to 3.0.0 introduces a major change to the project.

Comment thread UPGRADE.md Outdated

## 2.x -> 3.0.0

When upgrading from 2.x to 3.0.0 of OS2Display, a mayor change has been introduced to the project.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When upgrading from 2.x to 3.0.0 of OS2Display, a mayor change has been introduced to the project.
When upgrading from 2.x to 3.0.0 of OS2Display, a mayor change has been introduced to the project.

Comment thread assets/admin/components/user/login.jsx Outdated

const oidcLogins = loginMethods.filter(
(loginMethod) => loginMethod.enabled && loginMethod.type === "oidc",
(loginMethod) => loginMethod.type === "oidc",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(loginMethod) => loginMethod.type === "oidc",
({ type }) =>type === "oidc",

Comment thread assets/admin/components/user/login.jsx Outdated
const usernamePasswordLogins = loginMethods.filter(
(loginMethod) =>
loginMethod.enabled && loginMethod.type === "username-password",
(loginMethod) => loginMethod.type === "username-password",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(loginMethod) => loginMethod.type === "username-password",
({ type }) => type === "username-password",

@sinejespersen sinejespersen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with suggestions for changes.

Comment thread README.md Outdated
## Stateless

The API is stateless except `/v2/authentication` routes.
Make sure to set the `CORS_ALLOW_ORIGIN` correctly in `.env.local`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the correct setting for a given domain?
Is this even relevant with mono repo setup given that the clients will always be hosted on the same domain?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I will investigate.

@tuj
tuj merged commit 21d3ef3 into release/3.0.0 Sep 1, 2025
17 checks passed
@tuj
tuj deleted the feature/developer-docs branch September 1, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants