Skip to content

Commit f457ac7

Browse files
TyperOfCodeTyperOfCode
committed
feature: added English version of user guide | 英語ユーザーガイドを追加
1 parent 37e6478 commit f457ac7

File tree

12 files changed

+156
-8
lines changed

12 files changed

+156
-8
lines changed

‎guide/src/SUMMARY.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
- [開発者向け・Contribution](./ja/for_developer.md)
1616

1717
# English
18-
- [Find Problems]()
19-
- [Progress]()
20-
- [Recommend]()
21-
- [Virtual Contests]()
22-
- [Others]()
23-
- [My Lists]()
24-
- [Reset Progress]()
25-
- [For Developers, Contribution]()
18+
- [Find Problems](./en/find_problems.md)
19+
- [Progress](./en/progress.md)
20+
- [Recommend](./en/recommend.md)
21+
- [Virtual Contests](./en/virtual_contest.md)
22+
- [Others](./en/misc.md)
23+
- [My Lists](./en/problem_list.md)
24+
- [Reset Progress](./en/reset_progress.md)
25+
- [For Developers, Contribution](./en/for_developer.md)

‎guide/src/en/README.md

Whitespace-only changes.

‎guide/src/en/find_problems.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Finding Problems
2+
You can search for problems based on the following criteria:
3+
1. Filter by AC/non-AC
4+
1. Filter by AtCoder official score
5+
1. Filter by difficulty calculated independently
6+
1. Search by problem title, contest name, FA user, fastest user, etc.
7+
8+
## How to Search for Problems
9+
1. Enter your AtCoder ID in the User ID field at the top left of the page, and select `List` at the top of the page.
10+
1. By selecting the items under Problem List, you can filter problems based on AC/non-AC, AtCoder official score, and difficulty.
11+
1. If you know the problem's name or want to search based on Fastest (shortest execution time), Shortest (shortest code length), or First (fastest submission time) users, you can enter the problem name or user name into the `Search` field on the right.

‎guide/src/en/for_developer.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# For Developers / Contribution
2+
This page provides an overview of the contents of AtCoder Problems and details about contributions.
3+
# Components of AtCoder Problems
4+
An explanation of the components within AtCoder Problems.
5+
## Crawler (Rust)
6+
- Submission Crawler
7+
- Contest and Problem Crawler
8+
## API Server (Rust)
9+
## Frontend (TypeScript)
10+
## Aggregation Batch (Rust)
11+
- Differential Aggregation
12+
- Total Submission Aggregation
13+
## Difficulty Estimation (Python)
14+
- [Algorithm](https://pepsin-amylase.hatenablog.com/entry/atcoder-problems-difficulty)
15+
16+
# Contribution
17+
## Want to add or fix features
18+
- [GitHub](https://github.com/kenkoooo/AtCoderProblems)
19+
20+
## Want to make a request or report a bug
21+
- [GitHub issues](https://github.com/kenkoooo/AtCoderProblems/issues)
22+
23+
## Want to contribute to server costs
24+
- [GitHub Sponsors](https://github.com/sponsors/kenkoooo)

‎guide/src/en/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# AtCoder Problems User Guide (Japanese Version)
2+
3+
This is the user guide for AtCoder Problems.
4+
This guide explains how to use the various features of AtCoder Problems.
5+
6+
You can navigate to the desired page by using the sidebar on the left (menu icon at the top left) or the arrow buttons at the bottom of the page.

‎guide/src/en/misc.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Others
2+
## Glossary
3+
- Difficulty
4+
- This value indicates that a person with the current internal rating (unadjusted rating) would have a 50% chance of solving the problem in a contest.
5+
- There are problems with a test tube emoji (🧪) next to the estimated difficulty. This indicates that the difficulty was estimated using somewhat forceful methods for problems before the official rating system was introduced.
6+
- A problem with a Difficulty of X means "half of the people with a rating of X can solve this problem," not "everyone with a rating of X can solve this problem."
7+
8+
- Streak
9+
- The number of consecutive days you have solved new problems that you haven't solved before.
10+
- Longest Streak is calculated based on JST, while Current Streak is calculated based on Local Time.
11+
- Solving a problem that you have solved before will not increase the Streak count.
12+
13+
## References
14+
The following web pages were referenced in creating this user guide.
15+
1. https://ntk-ta01.hatenablog.com/entry/2020/04/15/001405
16+
1. https://trap.jp/post/992/
17+
1. https://pepsin-amylase.hatenablog.com/entry/atcoder-problems-difficulty

‎guide/src/en/problem_list.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Creating a Problem List
2+
You can create your own problem list for review and other purposes.
3+
## How to Use
4+
1. Log in from the Login button at the top right and enter your AtCoder ID to save it.
5+
2. After logging in, the My Lists tab will appear in the menu. Click Create New List to enter the edit screen.
6+
3. Click Add, and a prompt saying Search here to add problems will appear. Enter the title of the problem you want to add to the list and select the problem.
7+
4. To delete a problem, click Remove.

‎guide/src/en/progress.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Progress Tracking
2+
You can check from the `User` tab.
3+
## Achievement
4+
You can view numbers such as AC count (number of problems solved correctly), Rated Point Sum (total score of solved rated problems), and Current Streak (number of consecutive days solving new problems).
5+
6+
## AtCoder Pie Charts
7+
You can view pie charts showing the proportions of AC, Non-AC (submitted but not solved), and NoSub (not submitted) problems out of the total number of problems.
8+
9+
## Difficulty Pies
10+
You can view pie charts showing the proportions of AC, Non-AC (submitted but not solved), and NoSub (not submitted) problems for each difficulty level (grey, brown, green, etc.).
11+
12+
## Category Pies
13+
You can view pie charts showing the proportions of AC, Non-AC (submitted but not solved), and NoSub (not submitted) problems for each contest category.
14+
15+
## Progress Charts
16+
### Daily Effort
17+
You can view the number of ACs per day.
18+
19+
### Climbing
20+
You can view the cumulative number of ACs, color coded by difficulty.
21+
22+
### Heatmap
23+
You can view the number of ACs per day in the same format as GitHub contributions.
24+
It is divided into All Submissions, All AC, Unique AC (problems solved for the first time), and Max Difficulty (the highest difficulty of problems solved that day).
25+
26+
## Submissions
27+
You can view the list of your submitted codes, their correctness status, and the languages used.
28+
29+
## Languages
30+
You can view the number of ACs, Longest Streak, Current Streak, and Last AC (date of the last AC) for each submission language.
31+
32+
## Trophy
33+
You can earn trophies by achieving specific milestones. The names of the trophies are a surprise until you achieve them.
34+
35+
## All
36+
You can view all items on one page.

‎guide/src/en/recommend.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Recommendation
2+
This feature automatically displays recommended problems based on your current rating.
3+
You can check it from the Recommendation tab on the User page.
4+
You can choose the difficulty of the problems from Easy, Moderate, or Difficult.
5+
6+
Additionally, you can exclude problems that you have solved once or recently from the recommendations.
7+
8+
## Detailed Explanation
9+
- Easy problems are those with an 80% chance of being solved, Moderate problems with a 50% chance, and Difficult problems with a 20% chance.
10+
- Exclude ~~~ allows you to choose the type of problems to exclude from the recommendations.
11+
- If you select Don't exclude solved problems, all problems will be included in the recommendations.
12+
- The number on the right allows you to select the number of recommendations to display on the screen.
13+
- By selecting the checkbox next to the problem title, you can create a virtual contest with the selected problems.

‎guide/src/en/reset_progress.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Reset Progress
2+
You can set already AC problems to be treated as if they have not been AC yet.
3+
## How to Use
4+
1. Log in with your GitHub account from the Login button at the top right, then enter and save your AtCoder ID.
5+
2. After logging in, the Reset Progress tab will appear in the menu. Specify the problem, and your progress will be reset.

0 commit comments

Comments
 (0)