Add articles for using paragraph breaks and quote styles #36
Conversation
|
🚀 Preview deployed! You can preview this PR at: https://pr-36--sf-help-preview.netlify.app |
removed quote style image - will replace
reuploading quote styles image
Added correct image for quote styles
Images updated
|
Ready for your review! @Nateowami |
There was a problem hiding this comment.
Pull Request Overview
This PR adds two new documentation articles explaining formatting features in Scripture Forge's draft generation system. The articles cover how AI-generated drafts can automatically restore proper paragraph breaks and quotation mark styles.
- Introduces documentation for the Quote Styles feature that restores project-specific quotation marks
- Introduces documentation for the Paragraph Breaks feature with options for handling paragraph markers
- Provides step-by-step instructions and feature notes for both formatting options
Reviewed Changes
Copilot reviewed 2 out of 8 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/Draft-Generation/using-quote-styles.md | Documents the Quote Styles feature including automatic quote restoration, usage steps, and feature notifications |
| docs/Draft-Generation/using-paragraph-breaks.md | Documents the Paragraph Breaks feature with three formatting options (Best Guess, Remove, Move to End) |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| « … » | ||
| 「 … 」 | ||
|
|
||
| On the Generate Draft page is Formatting Options button which will allow you to set up the paragraph breaks and quote styles for your draft. After the initial set up, you can return to the Formatting Options page and change your settings. |
There was a problem hiding this comment.
Missing article 'a' before 'Formatting Options button'.
| On the Generate Draft page is Formatting Options button which will allow you to set up the paragraph breaks and quote styles for your draft. After the initial set up, you can return to the Formatting Options page and change your settings. | |
| On the Generate Draft page is the Formatting Options button which will allow you to set up the paragraph breaks and quote styles for your draft. After the initial set up, you can return to the Formatting Options page and change your settings. |
|
|
||
| 1. Navigate to the Generate Draft page in Scripture Forge. | ||
| 2. Select the book you want to draft (e.g. 1 Kings). | ||
| 3. Before generating a new draft, select Formatting Options. |
There was a problem hiding this comment.
Extra space between 'generating' and 'a'.
| 3. Before generating a new draft, select Formatting Options. | |
| 3. Before generating a new draft, select Formatting Options. |
| 1. Navigate to the Generate Draft page in Scripture Forge. | ||
| 2. Select the book you want to draft (e.g. 1 Kings). | ||
| 3. Before generating a new draft, select Formatting Options. | ||
| 4. Select the options for quote styles to apply to the draft. The two options are "Automatic quote style" or "Straight quotes". |
There was a problem hiding this comment.
Extra space between 'are' and the opening quotation mark.
| 4. Select the options for quote styles to apply to the draft. The two options are "Automatic quote style" or "Straight quotes". | |
| 4. Select the options for quote styles to apply to the draft. The two options are "Automatic quote style" or "Straight quotes". |
|
|
||
| 5. Click save. | ||
| 6. Review the output: | ||
| If quote styles are applied, you will see the project’s preferred quotation marks. |
There was a problem hiding this comment.
Extra space between 'styles' and 'are'.
| If quote styles are applied, you will see the project’s preferred quotation marks. | |
| If quote styles are applied, you will see the project’s preferred quotation marks. |
| 2. **Unable to determine quote styles:** | ||
| Quotation marks were not adjusted because your project’s style could not be detected. Straight quotes were used in this chapter. | ||
| 3. **Unable to apply to this chapter:** | ||
| Quotation marks in this chapter were used in this chapter because styles could not be applied accurately. |
There was a problem hiding this comment.
The phrase 'in this chapter' is repeated, creating redundancy. Consider revising to: 'Quotation marks could not be adjusted in this chapter because styles could not be applied accurately.'
| Quotation marks in this chapter were used in this chapter because styles could not be applied accurately. | |
| Quotation marks could not be adjusted in this chapter because styles could not be applied accurately. |
|
|
||
| 1. Navigate to the Generate Draft page in Scripture Forge. | ||
| 2. Select the book you want to draft (e.g. 1 Kings). | ||
| 3. Before generating a new draft, select Formatting Options. |
There was a problem hiding this comment.
Extra space between 'generating' and 'a'.
| 3. Before generating a new draft, select Formatting Options. | |
| 3. Before generating a new draft, select Formatting Options. |
Nateowami
left a comment
Nateowami
left a comment
There was a problem hiding this comment.
Here's the notice I'd prepared to add to the generate draft page:
Notice there's a single link. I'd envisioned a single article about the draft options. How do we want to handle this?
| Quotation marks in this chapter were adjusted to match your project’s style. | ||
| 2. **Unable to determine quote styles:** | ||
| Quotation marks were not adjusted because your project’s style could not be detected. Straight quotes were used in this chapter. | ||
| 3. **Unable to apply to this chapter:** |
There was a problem hiding this comment.
I don't think this is something that's ever shown. I'm not sure what this refers to.
There was a problem hiding this comment.
Aren't these the notifications shown to users depending on if the quotes were or were not applied?
There was a problem hiding this comment.
[Sorry; I thought this comment posted yesterday and saw it was still a draft this morning]
Not on a per-chapter basis. The only place it's shown is whens selecting the options, and pertains to the entire draft:
Serval's remark lists the chapters where quotations were denormalized (though that message could use a lot of improvement).
Updated punctuation and some formatting errors.
Updated punctuation and some formatting errors.
Removed step 2 and updated wording on step 3
Removed step 2 and updated wording on step 3.
updated instruction numbering
No description provided.