Skip to content

🚸(backend) add onboarding docs for new users#1891

Open
Ash-Crow wants to merge 2 commits intomainfrom
sbl-onboarding-docs
Open

🚸(backend) add onboarding docs for new users#1891
Ash-Crow wants to merge 2 commits intomainfrom
sbl-onboarding-docs

Conversation

@Ash-Crow
Copy link
Collaborator

@Ash-Crow Ash-Crow commented Feb 16, 2026

Purpose

Some users are not super familiar with block based structured editors, slash commands, markdown etc.
Docs is super confusing for them. This adds both read-only tutorials and a sandbox owned by the user.

Fix #393

Proposal

  • Adds two methods to allow new users to start with some docs.
    • User._handle_onboarding_documents_access() gives READER access to each document listed in settings.USER_ONBOARDING_DOCUMENTS.
    • User._duplicate_onboarding_sandbox_document() creates a local copy of the sandbox document specified in
      settings.USER_ONBOARDING_SANDBOX_DOCUMENT.
  • Fix some formating issues with the docs/env.md file with the help of a Markdown table formatter

@Ash-Crow Ash-Crow force-pushed the sbl-onboarding-docs branch from 3e1fe4c to 95f29f2 Compare February 16, 2026 15:06
Adds two methods to allow new users to start with some docs.

User._handle_onboarding_documents_access() gives READER access to
each document listed in settings.USER_ONBOARDING_DOCUMENTS.

User._duplicate_onboarding_sandbox_document() creates a local copy
of the sandbox document specified in
settings.USER_ONBOARDING_SANDBOX_DOCUMENT.
@Ash-Crow Ash-Crow force-pushed the sbl-onboarding-docs branch from 95f29f2 to f9a3f0c Compare February 16, 2026 16:21
@Ash-Crow Ash-Crow requested a review from lunika February 16, 2026 16:22
Update _duplicate_onboarding_sandbox_document() to return immediately
if the doc defined in settings can't be found.
@Ash-Crow Ash-Crow requested a review from lunika February 18, 2026 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Onboarding Docs for new users

2 participants