mirror of
https://github.com/Rakantor/torii-srs-public.git
synced 2026-09-21 22:32:00 +02:00
Compare commits
3
Commits
d088ebfb05
...
965523a9bb
| Author | SHA1 | Date | |
|---|---|---|---|
 Rakantor
|
965523a9bb | ||
|
Rakantor
|
0179e40388 | ||
|
Rakantor
|
3b4057e16f |
@@ -1,32 +0,0 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug in the Torii SRS Web App
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
@@ -0,0 +1,130 @@
|
||||
name: Bug report
|
||||
description: Something in the Torii web app is broken or behaving strangely.
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time. Two quick things that fix many reports:
|
||||
**reload the page**, and check the **cloud icon** at the foot of the navigation menu —
|
||||
items queued there mean you're offline or the server is out of reach.
|
||||
|
||||
Still broken? Fill this in. The [Knowledge Base](https://app.torii-srs.com/faq) covers
|
||||
the common ones if you'd rather check first.
|
||||
|
||||
- type: checkboxes
|
||||
id: checks
|
||||
attributes:
|
||||
label: Before you post
|
||||
options:
|
||||
- label: I searched the existing issues, including closed ones.
|
||||
required: true
|
||||
- label: I reloaded the page and it still happens.
|
||||
required: true
|
||||
- label: I'm not in a private/incognito window (Torii can't start in one).
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: What you saw, in your own words.
|
||||
placeholder: The answer field stopped accepting input after I got a word wrong.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Enough that we can do the same thing and watch it break.
|
||||
placeholder: |
|
||||
1. Start a review session
|
||||
2. Answer a meaning question wrong
|
||||
3. Press Enter to continue
|
||||
4. …
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: What did you expect instead?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Where in the app?
|
||||
options:
|
||||
- Reviews
|
||||
- Lessons
|
||||
- Self-study
|
||||
- Dashboard
|
||||
- Browse
|
||||
- Add words
|
||||
- Stats
|
||||
- Settings
|
||||
- Sign-in / sign-up
|
||||
- Knowledge Base
|
||||
- Support Torii / membership
|
||||
- Somewhere else
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: browser
|
||||
attributes:
|
||||
label: Browser
|
||||
options:
|
||||
- Chrome
|
||||
- Firefox
|
||||
- Safari
|
||||
- Edge
|
||||
- Brave / Vivaldi / Arc
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: device
|
||||
attributes:
|
||||
label: Device, OS and browser version
|
||||
placeholder: iPhone 14, iOS 18.3, Safari 18
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: install
|
||||
attributes:
|
||||
label: How were you using Torii?
|
||||
options:
|
||||
- In a browser tab
|
||||
- Installed as an app (added to home screen / desktop)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: conditions
|
||||
attributes:
|
||||
label: Anything true at the time?
|
||||
options:
|
||||
- label: I was offline, or my connection was unreliable.
|
||||
- label: It happens every time.
|
||||
- label: It started after a recent update.
|
||||
|
||||
- type: textarea
|
||||
id: extra
|
||||
attributes:
|
||||
label: Screenshots or anything else
|
||||
description: Drag images straight in. A screenshot of the moment it went wrong is worth a lot.
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
---
|
||||
**Got an account?** The in-app contact form (*Knowledge Base → Still stuck?*) can attach a
|
||||
diagnostics file — a record of what the app did on your device, with no email address and
|
||||
nothing you wrote in it. Send it there rather than here (this tracker is public) and
|
||||
mention the issue number.
|
||||
@@ -0,0 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Knowledge Base — how Torii works
|
||||
url: https://app.torii-srs.com/faq
|
||||
about: Searchable answers on lessons, reviews, the SRS stages, offline mode and accounts. Start here for questions.
|
||||
- name: Account, payments or your data
|
||||
url: https://app.torii-srs.com/faq#still-stuck
|
||||
about: Anything needing your email address. Issues here are public, so please write to us instead.
|
||||
- name: Anything else
|
||||
url: https://app.torii-srs.com/faq#still-stuck
|
||||
about: No account, or nothing above fits. We read every one.
|
||||
@@ -1,20 +0,0 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest a feature for Torii SRS
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is.
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
@@ -0,0 +1,57 @@
|
||||
name: Feature request
|
||||
description: Suggest something new, or a change to how something works.
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Ideas are welcome, and the good ones usually start from a real annoyance rather than a
|
||||
feature name — so tell us what's in your way, not only what to build.
|
||||
|
||||
- type: checkboxes
|
||||
id: checks
|
||||
attributes:
|
||||
label: Before you post
|
||||
options:
|
||||
- label: I searched the existing issues, including closed ones.
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What's the problem?
|
||||
description: What are you trying to do, and where does Torii get in the way?
|
||||
placeholder: I study on the train and lose my place whenever the tunnel kills the connection.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposal
|
||||
attributes:
|
||||
label: What would you like Torii to do?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: workaround
|
||||
attributes:
|
||||
label: How do you handle it today?
|
||||
description: Workarounds tell us how much the current behaviour costs you.
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Which part of the app?
|
||||
options:
|
||||
- Reviews
|
||||
- Lessons
|
||||
- Self-study
|
||||
- Dashboard
|
||||
- Browse
|
||||
- Add words
|
||||
- Stats
|
||||
- Settings
|
||||
- Offline & syncing
|
||||
- Something else / the whole app
|
||||
validations:
|
||||
required: true
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 180 KiB |
@@ -1,16 +1,116 @@
|
||||
<p align="center">
|
||||
<a href="https://beta.torii-srs.com" target="_blank">
|
||||
<img src="https://user-images.githubusercontent.com/8210657/188132069-ae5edce9-85c3-4aac-b03b-a7d760c7a21e.png" width="128">
|
||||
<a href="https://app.torii-srs.com" target="_blank" rel="noopener">
|
||||
<img src=".github/assets/torii-logo.png" alt="Torii SRS" width="112" height="112">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## Issue and feature request tracker for the Torii SRS Web App.
|
||||
<h1 align="center">Torii SRS — Issues & Feature Requests</h1>
|
||||
|
||||
### IMPORTANT INFORMATION
|
||||
* Only submit Web App issues. Issues concerning the Desktop/Android (Java) app may be closed immediately.
|
||||
* The issue list of this repo is **exclusively** for Bug Reports and Feature Requests.
|
||||
* **Search** for your issue before opening a new one. It _may_ have been answered.
|
||||
<p align="center">
|
||||
The public tracker for the <b>Torii SRS</b> web app: a free Japanese vocabulary trainer<br>
|
||||
built on spaced repetition. Report a bug, or ask for something that isn't there yet.
|
||||
</p>
|
||||
|
||||
### Questions
|
||||
<p align="center">
|
||||
<a href="https://github.com/Rakantor/torii-srs-public/issues/new?template=bug_report.yml"><img alt="Report a bug" src="https://img.shields.io/badge/report-a%20bug-1976d2?style=flat-square"></a>
|
||||
<a href="https://github.com/Rakantor/torii-srs-public/issues/new?template=feature_request.yml"><img alt="Request a feature" src="https://img.shields.io/badge/request-a%20feature-2e9e4f?style=flat-square"></a>
|
||||
<a href="https://github.com/Rakantor/torii-srs-public/issues"><img alt="Open issues" src="https://img.shields.io/github/issues/Rakantor/torii-srs-public?style=flat-square&color=1976d2&label=open"></a>
|
||||
<a href="https://github.com/Rakantor/torii-srs-public/issues?q=is%3Aissue+is%3Aclosed"><img alt="Closed issues" src="https://img.shields.io/github/issues-closed/Rakantor/torii-srs-public?style=flat-square&color=6b7280&label=closed"></a>
|
||||
</p>
|
||||
|
||||
For help, support and general questions, please use the contact form in the web app or contact us at support@torii-srs.com. The issue list of this repo is **exclusively** for reporting bugs, suggesting enhancements and requesting features.
|
||||
<p align="center">
|
||||
<a href="https://app.torii-srs.com">Open the app</a> ·
|
||||
<a href="https://app.torii-srs.com/faq">Knowledge Base</a> ·
|
||||
<a href="https://github.com/Rakantor/torii-srs-public/issues">Browse issues</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## What this repository is
|
||||
|
||||
An issue list, and nothing else. There is no source code here.
|
||||
|
||||
It exists so that bugs and feature requests are **public** — you can see what's already been
|
||||
reported, add to it, and watch it get fixed. Everything else has a better address:
|
||||
|
||||
| I want to… | Go here |
|
||||
| :--- | :--- |
|
||||
| Report something broken | [Bug report →](https://github.com/Rakantor/torii-srs-public/issues/new?template=bug_report.yml) |
|
||||
| Suggest a feature or a change | [Feature request →](https://github.com/Rakantor/torii-srs-public/issues/new?template=feature_request.yml) |
|
||||
| Ask how something works | [Knowledge Base →](https://app.torii-srs.com/faq) |
|
||||
| Get help with an account, a payment or your data | Use the contact form in the app or on the website |
|
||||
| Anything else | Use the contact form in the app or on the website |
|
||||
|
||||
## Before you open an issue
|
||||
|
||||
Three things fix most of what gets reported, and they take a minute:
|
||||
|
||||
- [ ] **Search the [existing issues](https://github.com/Rakantor/torii-srs-public/issues?q=is%3Aissue).**
|
||||
Include closed ones — it may already be fixed and waiting on a release. Found it? Add a
|
||||
👍 and a comment rather than a new issue; both help more than a duplicate.
|
||||
- [ ] **Check the cloud icon** at the foot of the navigation menu. Items queued there mean you
|
||||
are offline or the server is out of reach, and the app is behaving correctly.
|
||||
- [ ] **Clear local storage** in *Settings → Account*. It throws away the local copy and
|
||||
downloads your data again. Your progress is on the server and your preferences survive.
|
||||
|
||||
Two things that look like bugs but aren't:
|
||||
|
||||
- **Private / incognito windows.** Torii keeps your whole collection in the browser's local
|
||||
database, which is what lets it work offline. Private windows restrict or wipe that storage,
|
||||
so it cannot start properly. A normal window is the fix.
|
||||
- **Old browsers.** Current versions of Chrome, Firefox, Safari and Edge are supported, on
|
||||
desktop and mobile — plus anything built on them, like Brave, Vivaldi or Arc. Cookies need
|
||||
to be on; that's how you stay signed in.
|
||||
|
||||
## What makes a report easy to fix
|
||||
|
||||
The [bug report form](https://github.com/Rakantor/torii-srs-public/issues/new?template=bug_report.yml)
|
||||
asks for all of this, so you can just fill it in:
|
||||
|
||||
- **What you did, step by step** — enough that we can do the same thing and watch it break.
|
||||
- **What you expected, and what happened instead.** Both, even when one seems obvious.
|
||||
- **Where in the app** — Lessons, Reviews, the dashboard, Settings.
|
||||
- **Browser, version and device.** "Safari 18 on an iPhone" is plenty.
|
||||
- **A screenshot**, if there's anything to see. Drag it straight into the form.
|
||||
|
||||
> [!TIP]
|
||||
> **The diagnostics file belongs in the contact form, not here.** If you have an account, the
|
||||
> in-app contact form (*Knowledge Base → Still stuck?*) can attach a record of what the app did
|
||||
> on your device over the last couple of weeks — which saves you describing any of it. It holds
|
||||
> no email address and nothing you wrote, but this tracker is public, so send it there and
|
||||
> mention the issue number here.
|
||||
|
||||
## In scope, and out
|
||||
|
||||
**In scope:** anything in the web app at [app.torii-srs.com](https://app.torii-srs.com) — the
|
||||
site itself, the installed app, offline behaviour, syncing, reviews, lessons, stats, settings.
|
||||
Wrong or missing word data counts too: readings, meanings, pitch accents, audio, example
|
||||
sentences.
|
||||
|
||||
**Out of scope:**
|
||||
|
||||
- **The old Desktop and Android (Java) apps.** They're a separate, unmaintained thing; issues
|
||||
about them may be closed without a reply.
|
||||
- **Account, billing and privacy requests.** They need your email address, which shouldn't be
|
||||
in a public issue — use the contact form in the app or on the website instead.
|
||||
- **Support questions.** Try the [Knowledge Base](https://app.torii-srs.com/faq) first; if it
|
||||
doesn't answer you, write to us and we'll answer directly.
|
||||
|
||||
## What happens next
|
||||
|
||||
Every issue gets read. Not every one gets built — the honest version is that Torii is small,
|
||||
there are no ads and no investors, and time goes where it helps the most people.
|
||||
|
||||
What you can expect: a reply, a label (`bug`, `enhancement`, `needs-info`, `duplicate`), and a
|
||||
close when the fix ships. Shipped changes should show up in the app's release notes and under
|
||||
*Knowledge Base → What's new*. Feature requests that aren't planned get told so plainly rather
|
||||
than left open forever.
|
||||
|
||||
## Thank you!
|
||||
|
||||
Every bug someone bothered to write up made this app better than it would have been. It is
|
||||
appreciated more than the issue-closing note lets on.
|
||||
|
||||
<p align="center">
|
||||
<sub>一つずつ — one at a time.</sub>
|
||||
</p>
|
||||
Reference in New Issue
Block a user