authgear / authgear/authgear-server

Add help text for cookie / token lifetime setting

Open
#1,836 0 comments 0 reactions 0 assignees View on GitHub
ux/major
Dominant language
Go
Stars
2k
Forks
125
Avg merge
2d 17h
Merged PRs (30d)
32

Description

The following settings might be confusing for non-authentication professional developers, which goes against the principle of we want Authgear to be easy to use.

Consider adding some explanation text as follow? (Under Applications setting page)

1. Applications
1. "allowing HTTP requests from the list of domains specified here." maybe explain in a more layman terms? Like allowing authentication requests from these domains name? etc?
2. Persistent Cookie
3. Session lifetime (seconds)
4. Invalidate session after idling
5. Idle Timeout (seconds)
2. Applications > Edit > Token Settings
1. Access Token Lifetime (maybe this one have no good explanation and just keep as is)
2. Refresh Token Lifetime (should explain this is basically "Lifetime of session after login"?)
3. Invalidate...

Thoughts: actually maybe we should put the help text as the major option, and add the technical terms after it? Something like this?

![eg](https://uploads.linear.app/860e83ae-05f0-4c4b-bd93-8a4b8d251836/23c1501e-3132-4efe-b009-30b1f49c6d7d/261d56a8-d785-44ad-8a4a-ff2dd8e28315?signature=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXRoIjoiLzg2MGU4M2FlLTA1ZjAtNGM0Yi1iZDkzLThhNGI4ZDI1MTgzNi8yM2MxNTAxZS0zMTMyLTRlZmUtYjAwOS0zMGIxZjQ5YzZkN2QvMjYxZDU2YTgtZDc4NS00NGFkLThhNGEtZmYyZGQ4ZTI4MzE1IiwiaWF0IjoxNzE4OTU5MzQ1LCJleHAiOjMzMjg5NTE5MzQ1fQ.bUKu4E0afTZwluLyF8Hp1ayHo42lB5mYcE_o4586dCA)

Contributor guide

Open the contributing guide

Research direction

Start at the Applications settings page and Applications > Edit > Token Settings, reviewing the labels for the listed cookie, session, and token lifetime options. Done means each confusing setting has concise, non-specialist help text while preserving the technical terminology where useful; the proposed wording and scope still need maintainer agreement.

Written by the indexing model from the issue text.

Assessment

Domain
authentication, documentation, frontend
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.