Repository navigation
Add a user guide published to GitHub Pages - #19
Merged
Merged
Conversation
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.
6 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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/..github/workflows/docs.ymlbuilds the book with a pinned mdBook 0.5.4 on PRs that touchdocs/, and deploys to Pages frommain.Checklist
cargo fmt --all -- --checkpasses (no Rust changes)cargo clippy --all-targets -- -D warningspasses (no Rust changes)cargo test --all-targetspasses (no Rust changes)cargo build --releasesucceeds (no Rust changes)CHANGELOG.mdupdated under[Unreleased], if user-facingNotes for the reviewer
mdbook build docsbuilds with no warnings.src/ui.actionlintpasses on the new workflow.mainthat touchesdocs/.