Skip to content

Commit

Permalink
Merge pull request #1480 from TyperOfCode/master
Browse files Browse the repository at this point in the history
Added English version of user guide | 英語ユーザーガイドを追加
  • Loading branch information
kenkoooo authored Jul 26, 2024
2 parents 37e6478 + f457ac7 commit ff203e2
Show file tree
Hide file tree
Showing 12 changed files with 156 additions and 8 deletions.
16 changes: 8 additions & 8 deletions guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
- [開発者向け・Contribution](./ja/for_developer.md)

# English
- [Find Problems]()
- [Progress]()
- [Recommend]()
- [Virtual Contests]()
- [Others]()
- [My Lists]()
- [Reset Progress]()
- [For Developers, Contribution]()
- [Find Problems](./en/find_problems.md)
- [Progress](./en/progress.md)
- [Recommend](./en/recommend.md)
- [Virtual Contests](./en/virtual_contest.md)
- [Others](./en/misc.md)
- [My Lists](./en/problem_list.md)
- [Reset Progress](./en/reset_progress.md)
- [For Developers, Contribution](./en/for_developer.md)
Empty file added guide/src/en/README.md
Empty file.
11 changes: 11 additions & 0 deletions guide/src/en/find_problems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Finding Problems
You can search for problems based on the following criteria:
1. Filter by AC/non-AC
1. Filter by AtCoder official score
1. Filter by difficulty calculated independently
1. Search by problem title, contest name, FA user, fastest user, etc.

## How to Search for Problems
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.
1. By selecting the items under Problem List, you can filter problems based on AC/non-AC, AtCoder official score, and difficulty.
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.
24 changes: 24 additions & 0 deletions guide/src/en/for_developer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# For Developers / Contribution
This page provides an overview of the contents of AtCoder Problems and details about contributions.
# Components of AtCoder Problems
An explanation of the components within AtCoder Problems.
## Crawler (Rust)
- Submission Crawler
- Contest and Problem Crawler
## API Server (Rust)
## Frontend (TypeScript)
## Aggregation Batch (Rust)
- Differential Aggregation
- Total Submission Aggregation
## Difficulty Estimation (Python)
- [Algorithm](https://pepsin-amylase.hatenablog.com/entry/atcoder-problems-difficulty)

# Contribution
## Want to add or fix features
- [GitHub](https://github.com/kenkoooo/AtCoderProblems)

## Want to make a request or report a bug
- [GitHub issues](https://github.com/kenkoooo/AtCoderProblems/issues)

## Want to contribute to server costs
- [GitHub Sponsors](https://github.com/sponsors/kenkoooo)
6 changes: 6 additions & 0 deletions guide/src/en/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# AtCoder Problems User Guide (Japanese Version)

This is the user guide for AtCoder Problems.
This guide explains how to use the various features of AtCoder Problems.

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.
17 changes: 17 additions & 0 deletions guide/src/en/misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Others
## Glossary
- Difficulty
- 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.
- 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.
- 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."

- Streak
- The number of consecutive days you have solved new problems that you haven't solved before.
- Longest Streak is calculated based on JST, while Current Streak is calculated based on Local Time.
- Solving a problem that you have solved before will not increase the Streak count.

## References
The following web pages were referenced in creating this user guide.
1. https://ntk-ta01.hatenablog.com/entry/2020/04/15/001405
1. https://trap.jp/post/992/
1. https://pepsin-amylase.hatenablog.com/entry/atcoder-problems-difficulty
7 changes: 7 additions & 0 deletions guide/src/en/problem_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Creating a Problem List
You can create your own problem list for review and other purposes.
## How to Use
1. Log in from the Login button at the top right and enter your AtCoder ID to save it.
2. After logging in, the My Lists tab will appear in the menu. Click Create New List to enter the edit screen.
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.
4. To delete a problem, click Remove.
36 changes: 36 additions & 0 deletions guide/src/en/progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Progress Tracking
You can check from the `User` tab.
## Achievement
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).

## AtCoder Pie Charts
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.

## Difficulty Pies
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.).

## Category Pies
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.

## Progress Charts
### Daily Effort
You can view the number of ACs per day.

### Climbing
You can view the cumulative number of ACs, color coded by difficulty.

### Heatmap
You can view the number of ACs per day in the same format as GitHub contributions.
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).

## Submissions
You can view the list of your submitted codes, their correctness status, and the languages used.

## Languages
You can view the number of ACs, Longest Streak, Current Streak, and Last AC (date of the last AC) for each submission language.

## Trophy
You can earn trophies by achieving specific milestones. The names of the trophies are a surprise until you achieve them.

## All
You can view all items on one page.
13 changes: 13 additions & 0 deletions guide/src/en/recommend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Recommendation
This feature automatically displays recommended problems based on your current rating.
You can check it from the Recommendation tab on the User page.
You can choose the difficulty of the problems from Easy, Moderate, or Difficult.

Additionally, you can exclude problems that you have solved once or recently from the recommendations.

## Detailed Explanation
- Easy problems are those with an 80% chance of being solved, Moderate problems with a 50% chance, and Difficult problems with a 20% chance.
- Exclude ~~~ allows you to choose the type of problems to exclude from the recommendations.
- If you select Don't exclude solved problems, all problems will be included in the recommendations.
- The number on the right allows you to select the number of recommendations to display on the screen.
- By selecting the checkbox next to the problem title, you can create a virtual contest with the selected problems.
5 changes: 5 additions & 0 deletions guide/src/en/reset_progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Reset Progress
You can set already AC problems to be treated as if they have not been AC yet.
## How to Use
1. Log in with your GitHub account from the Login button at the top right, then enter and save your AtCoder ID.
2. After logging in, the Reset Progress tab will appear in the menu. Specify the problem, and your progress will be reset.
3 changes: 3 additions & 0 deletions guide/src/en/training.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Training Mode
There are 300 problems available for beginners.
You can access it from `Training` at the top left. Click `Challenge` to display the problem.
26 changes: 26 additions & 0 deletions guide/src/en/virtual_contest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Virtual Contest
A virtual contest is a simulated contest where you can choose the problems you want to solve and set the time limit freely.

## Preparations for Participation
First, log in with your GitHub account from the Login button at the top right. (If you do not have a GitHub account, please create one.)
Then, enter and save your AtCoder ID.

## Creating a Virtual Contest
1. Click [Virtual Contests](https://kenkoooo.com/atcoder/#/contest/recent) at the top right to open the virtual contest page.
1. Click `Create New Contest` to go to the contest creation page.
1. Follow the instructions on the page to specify the date, time, and problems, and finally click `Create Contest` to complete the contest creation.
- Tips for Creating a Virtual Contest
- Bacha Gacha
- This feature randomly selects problems when you specify a range of difficulty.
- If you enter the AtCoder IDs of expected participants in the Expected Participants field and specify Exclude ~~~, problems that participants have already solved will be excluded. This is recommended to ensure fairness.
- Mode
- There are three types: Normal, Lockout, and Training.
- Normal is the standard mode. Participants are ranked based on their total score and penalties.
- In Lockout mode, only the first person to solve each problem gets the points.
- In Training mode, the scoreboard display is simplified. This mode is recommended when there are many problems. Participants are ranked based on the total number of problems solved and the time of the last correct submission.

## Participating in a Virtual Contest
1. Click [Virtual Contests](https://kenkoooo.com/atcoder/#/contest/recent) at the top right to open the virtual contest page.
Select the contest you want to participate in from Running Contests or Upcoming Contests. Click `Join` to complete the registration.
1. The problems will be displayed when the contest starts.
1. After getting AC on AtCoder, the standings on the virtual contest will be updated a few minutes later.

0 comments on commit ff203e2

Please sign in to comment.