Skip to content

Commit 62897c4

Browse files
authored
Documentation improvements (#70)
* Updated Review Docs Content * Missing indent in docs
1 parent 3790eb8 commit 62897c4

1 file changed

Lines changed: 36 additions & 18 deletions

File tree

README.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,44 @@
1-
Review allows you to share unpublished entries or revisions with collaborators without having to create a User for them.
1+
## Meet Review
22

3-
For example, you can create a draft `About Us` page and give folks a URL to view that draft content. You can also share a working copy, if you're using revisions.
3+
Review helps teams streamline content approvals by making it easy to share draft content with anyone. Editors can generate a review URL for any unpublished content and send it to clients, teammates, or stakeholders. Reviewers can immediately view the content without needing a Statamic user account. Review also works with revisions, allowing teams to share the latest working copy of an entry while edits continue.
44

5-
**Localization:**
5+
### Key Features
66

7-
To localize the button, add a lang file in `/resources/lang` with the name matching the locale, like `fr.json`. In it put your translation:
7+
- **Share Drafts with Anyone** – Generate a public review link for any unpublished entry. Anyone with the link can view the content.
8+
- **Streamline Content Approvals** – Share review links with stakeholders and collect feedback without slowing down your publishing workflow.
9+
- **Works with Revisions** – Share the latest working copy of an entry while edits continue.
810

9-
```
10-
{
11-
"Copy Review URL to Clipboard": "Translate Me!"
12-
}
13-
```
11+
---
12+
13+
## How It Works
14+
15+
After installing the addon package via composer, add the Review fieldtype to the sidebar of an entry blueprint.
16+
17+
The fieldtype provides a "Copy Review URL" button that copies a review link for the entry to your clipboard. This link can then be shared with collaborators.
18+
19+
The review link displays the unpublished draft or working copy of the entry.
20+
21+
### Requirements
1422

15-
**Getting the Review URL:**
23+
The "Copy Review URL" button works when:
1624

17-
Review fieldtype: Recommend adding it to the top of the sidebar of any entry blueprint: ![screenshot of copy review url button](https://github.com/transformstudios/statamic-review/raw/main/img/Copy%20URL%20Button.png "Copy Review URL Button")
25+
- The field is added to a blueprint _(not a fieldset due to a Statamic limitation)_
26+
- The site is served over HTTPS
27+
- The content is not published
1828

19-
**Please note**:
29+
### Things to Know
2030

21-
* Button will only work if:
22-
* the field was added to a blueprint and **not** a fieldset (Statamic issue)
23-
* the site is served via `https`
24-
* content is NOT published
25-
* URLs are public, anyone can view them.
26-
* Once the content is published, visiting that URL redirects to the actual content, unless there is a working copy.
31+
- Review URLs are public. Anyone with the link can access the content.
32+
- When the entry is published, the review URL redirects to the live page unless a working copy exists.
33+
34+
---
35+
36+
## Localization
37+
38+
To localize the Review fieldtype button text, add a language file in `/resources/lang` matching your locale. For example `ar.json`:
39+
40+
```
41+
{
42+
"Copy Review URL": "انسخ عنوان URL الخاص بالمراجعة"
43+
}
44+
```

0 commit comments

Comments
 (0)