Skip to content

Add a user guide published to GitHub Pages - #19

Merged
smaranjit merged 3 commits into
mainfrom
docs/user-guide
Oct 6, 2026
Merged

smaranjit merged 3 commits into
mainfrom
docs/user-guide

Conversation

@smaranjit

@smaranjit smaranjit commented Oct 6, 2026 •

Copy link
Copy Markdown
Owner

What does this change?

Adds a user guide as an mdBook under docs/, published to GitHub Pages at https://smaranjit.github.io/firebase-token-toolkit/.

  • Pages:
    • Getting started: installation, preparing a Firebase project, a quick start.
    • Using the app: the top bar, profiles, the Users panel, one page per tab, reading results.
    • Reference: settings storage, the Google endpoints called, troubleshooting with each error message and its fix, security, building from source.
  • Screenshots: every screenshot and the README's quick-start GIF were captured from the v0.1.6 Linux build against a demo Firebase project.
  • Workflow: new .github/workflows/docs.yml builds the book with a pinned mdBook 0.5.4 on PRs that touch docs/, and deploys to Pages from main.
  • Fixed docs that no longer matched the UI:
    • The persistence checkbox is labelled remember API key & App ID, not "Remember secrets".
    • That checkbox also gates the App Check debug token.
    • The tab names now match the app.
    • SECURITY.md no longer describes a footer GitHub link.
  • README and README.txt link to the guide. CHANGELOG and CONTRIBUTING are updated.

Checklist

  • cargo fmt --all -- --check passes (no Rust changes)
  • cargo clippy --all-targets -- -D warnings passes (no Rust changes)
  • cargo test --all-targets passes (no Rust changes)
  • cargo build --release succeeds (no Rust changes)
  • Tested manually against a Firebase project (a development one)
  • CHANGELOG.md updated under [Unreleased], if user-facing

Notes for the reviewer

  • Docs checks:
    • mdbook build docs builds with no warnings.
    • Every internal link and anchor resolves, and all images load with alt text, checked in a browser at desktop and phone widths.
    • Every UI label quoted in the guide was checked against src/ui.
    • actionlint passes on the new workflow.
  • Pages setup: the Pages source is set to GitHub Actions. The site deploys on the first push to main that touches docs/.
  • Stacked PR: Support web, Android and iOS apps per profile #20 builds on this branch and updates the guide for multiple apps.

Covers installation, preparing a Firebase project, a quick start, the top
bar, profiles, the Users panel, each tab, reading results, settings storage,
the Google endpoints used, troubleshooting, and security. Screenshots and the
quick-start recording were captured from the v0.1.6 Linux release against a
demo Firebase project, and every quoted label and message was checked against
src/ui.
Builds the book with a pinned mdBook on pushes to main and pull requests that
touch docs/, and deploys it to Pages from main. Pull requests only build, so a
broken SUMMARY or missing page fails the check without publishing.
The persistence checkbox is labelled "remember API key & App ID", not
"Remember secrets", and it also gates the App Check debug token. The tab
names in the README now match the app, and SECURITY.md no longer describes
a footer GitHub link that moved into the About dialog.
@smaranjit
smaranjit merged commit f1e5f38 into main Oct 6, 2026
11 checks passed
@smaranjit
smaranjit deleted the docs/user-guide branch October 6, 2026 20:05
@smaranjit smaranjit mentioned this pull request Oct 6, 2026
6 tasks done
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.

1 participant