Skip to content

Fix: typos #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix: typos #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fdc5ca
Fix: typos
omahs Jan 14, 2023
0815944
Fix: typo
omahs Jan 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contracts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A contract to allow submitting items into lists. These items have some amount of

## Features

- Slot system. Items and Disputes are stored in "slots", reusable storage that makes rewriting cheaper. Note that, unlike Slot Curate, if Stake Curate usage growth, reusing Item slots is actually rare, but it's still nice to have. Otherwise, Dispute slots should still be useful.
- Slot system. Items and Disputes are stored in "slots", reusable storage that makes rewriting cheaper. Note that, unlike Slot Curate, if Stake Curate usage grows, reusing Item slots is actually rare, but it's still nice to have. Otherwise, Dispute slots should still be useful.
- Storing the ipfsUris that hold the content of the items, list policies, etc, is outsourced to the subgraph.

## Development
Expand All @@ -23,4 +23,4 @@ If you want to see gas costs, do:

Check the size of the contracts:

`npx hardhat size-contracts`
`npx hardhat size-contracts`
8 changes: 4 additions & 4 deletions frontend/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ It shows you the *challenge types* there are accepted for removing items in this

According to the field types, the form will render errors if incorrect data is put in. Unless all mandatory fields are correctly filled, the "Submit" button will stay greyed out.

If the user does not have a Stake Curate account, or their account does not possess enough stake (in both value for the arbitration fees, and tokens for the challengers), then the "Submit" button takes a different shape. It shows you how much value and tokens you need to stake in order to be able to submit. Note tokens may need to be approved separatedly.
If the user does not have a Stake Curate account, or their account does not possess enough stake (in both value for the arbitration fees, and tokens for the challengers), then the "Submit" button takes a different shape. It shows you how much value and tokens you need to stake in order to be able to submit. Note tokens may need to be approved separately.

```
If not enough value If not enough tokens
Expand All @@ -45,7 +45,7 @@ If neither If enough
Advanced users may want to make this item stake be higher, in order to get punish griefers and get greater compensations from the damages they may cause, but I don't know how to provide this option in a simple way.


**Items Panel**: It shows you the items that were submitted to this list. There a bunch of filters, examples: Included, Challengeable, Removed, Outdated... . Included is the filter that's enabled by default.
**Items Panel**: It shows you the items that were submitted to this list. There is a bunch of filters, examples: Included, Challengeable, Removed, Outdated... . Included is the filter that's enabled by default.
For each item, it shows the properties of the latest edition. They are pruned or omitted if they need to, in order to fit. Clicking on an item directs to Item View.
In this view, if an item is challengeable, you can see how many tokens could you get by challenging and winning.
In case the List is a List of Lists, the Item instead provides a button to open the list, but it can still be clicked to check its details like any other Item.
Expand All @@ -64,7 +64,7 @@ If the item is challengeable, at the bottom, you can see how many tokens could y
If there are incorrect fields, that is, fields that do not correspond with the list version contemporary to the edition, a warning is shown besides them. This is in the form of a red warning sign, to the left of the field name. Hovering over the warning sign tells you the reason.
> Field 'Field' is unknown.

If there are mandatory missing fields, show a warning at the top of the edition. On hover, show the the missing fields.
If there are mandatory missing fields, show a warning at the top of the edition. On hover, show the missing fields.
> Field(s) 'Field1', Field2' are missing.

If there are validation errors for existing fields, warn on them as well with a yellow warning sign, and show the validation error.
Expand Down Expand Up @@ -142,4 +142,4 @@ These functions require the user to hold a certain amount of tokens and value in
- withdrawing funds from your account
- toggle for "auto-reveal"?
- explain outbidding in `itemStake`
- reconsider if modals should stay or be replaced
- reconsider if modals should stay or be replaced