Add articles for using paragraph breaks and quote styles by BiancaPaw · Pull Request #36 · sillsdev/scripture-forge-help

BiancaPaw · 2025-10-21T17:58:18Z

No description provided.

github-actions · 2025-10-21T18:14:38Z

🚀 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

BiancaPaw · 2025-10-24T13:37:06Z

Ready for your review! @Nateowami

Copilot

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.}

Copilot · 2025-10-24T14:20:06Z

docs/Draft-Generation/using-quote-styles.md

+« … »
+「 … 」
+
+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.


Missing article 'a' before 'Formatting Options button'.

Suggested change

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.

Copilot · 2025-10-24T14:20:06Z

docs/Draft-Generation/using-quote-styles.md

+
+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.


Extra space between 'generating' and 'a'.

Suggested change

3. Before generating a new draft, select Formatting Options.

3. Before generating a new draft, select Formatting Options.

Copilot · 2025-10-24T14:20:07Z

docs/Draft-Generation/using-quote-styles.md

+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".


Extra space between 'are' and the opening quotation mark.

Suggested change

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".

Copilot · 2025-10-24T14:20:07Z

docs/Draft-Generation/using-quote-styles.md

+
+5. Click save.
+6. Review the output:
+    If quote styles  are applied, you will see the project’s preferred quotation marks.


Extra space between 'styles' and 'are'.

Suggested change

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.

Copilot · 2025-10-24T14:20:07Z

docs/Draft-Generation/using-quote-styles.md

+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.


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.'

Suggested change

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.

Copilot · 2025-10-24T14:20:07Z

docs/Draft-Generation/using-paragraph-breaks.md

+
+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.


Extra space between 'generating' and 'a'.

Suggested change

3. Before generating a new draft, select Formatting Options.

3. Before generating a new draft, select Formatting Options.

Nateowami

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?

docs/Draft-Generation/using-paragraph-breaks.md

docs/Draft-Generation/using-quote-styles.md

docs/Draft-Generation/using-paragraph-breaks.md

docs/Draft-Generation/using-quote-styles.md

Nateowami · 2025-10-24T14:52:56Z

docs/Draft-Generation/using-quote-styles.md

+	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:**


I don't think this is something that's ever shown. I'm not sure what this refers to.

Aren't these the notifications shown to users depending on if the quotes were or were not applied?

[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.

Removed step 2 and updated wording on step 3

Removed step 2 and updated wording on step 3.

updated instruction numbering

Add articles for using paragraph breaks and quote styles

e4f3c11

BiancaPaw had a problem deploying to preview October 21, 2025 17:58 — with GitHub Actions Failure

Update using-paragraph-breaks.md

d590a12

BiancaPaw had a problem deploying to preview October 21, 2025 18:08 — with GitHub Actions Failure

Update using-quote-styles.md

14fbe69

BiancaPaw temporarily deployed to preview October 21, 2025 18:11 — with GitHub Actions Inactive

Fix capitalization

da3e003

Nateowami temporarily deployed to preview October 21, 2025 18:23 — with GitHub Actions Inactive

Images for Paragraph Breaks

e6a97a9

BiancaPaw temporarily deployed to preview October 21, 2025 18:25 — with GitHub Actions Inactive

Add images to paragraph breaks

c42237d

BiancaPaw temporarily deployed to preview October 21, 2025 18:32 — with GitHub Actions Inactive

Delete docs/Draft-Generation/pararaph_breaks_image3.png

76fee4e

BiancaPaw temporarily deployed to preview October 21, 2025 18:34 — with GitHub Actions Inactive

Added paragraph breaks image

5f258c6

BiancaPaw temporarily deployed to preview October 21, 2025 18:35 — with GitHub Actions Inactive

Update images using-paragraph-breaks.md

42996a0

BiancaPaw temporarily deployed to preview October 21, 2025 18:38 — with GitHub Actions Inactive

BiancaPaw marked this pull request as draft October 21, 2025 18:40

quote styles image uploaded

65cda5b

BiancaPaw temporarily deployed to preview October 21, 2025 19:20 — with GitHub Actions Inactive

Update quote styles images

75e0843

BiancaPaw had a problem deploying to preview October 21, 2025 20:04 — with GitHub Actions Failure

Update using-quote-styles.md

3706bb2

removed quote style image - will replace

BiancaPaw temporarily deployed to preview October 21, 2025 20:09 — with GitHub Actions Inactive

Delete docs/quote_styles_image1.png

a12b2fb

reuploading quote styles image

BiancaPaw temporarily deployed to preview October 24, 2025 13:01 — with GitHub Actions Inactive

Upload of image for quote styles

3df13b4

BiancaPaw temporarily deployed to preview October 24, 2025 13:03 — with GitHub Actions Inactive

Update using-quote-styles.md

a3e54ba

Added correct image for quote styles

BiancaPaw temporarily deployed to preview October 24, 2025 13:11 — with GitHub Actions Inactive

Added paragraph breaks options

1d171b9

BiancaPaw temporarily deployed to preview October 24, 2025 13:14 — with GitHub Actions Inactive

Update using-paragraph-breaks.md

90b1cd2

Images updated

BiancaPaw temporarily deployed to preview October 24, 2025 13:31 — with GitHub Actions Inactive

BiancaPaw marked this pull request as ready for review October 24, 2025 13:37

Nateowami requested a review from Copilot October 24, 2025 14:18

Copilot AI reviewed Oct 24, 2025

View reviewed changes

Compress new screenshots

e0f6b10

Nateowami temporarily deployed to preview October 24, 2025 14:28 — with GitHub Actions Inactive

Nateowami reviewed Oct 24, 2025

View reviewed changes

Update using-paragraph-breaks.md

6a7d1b9

Updated punctuation and some formatting errors.

BiancaPaw temporarily deployed to preview October 27, 2025 12:22 — with GitHub Actions Inactive

Update using-quote-styles.md

90ae555

Updated punctuation and some formatting errors.

BiancaPaw temporarily deployed to preview October 27, 2025 12:28 — with GitHub Actions Inactive

Update using-quote-styles.md

8afe704

Removed step 2 and updated wording on step 3

BiancaPaw temporarily deployed to preview October 27, 2025 21:02 — with GitHub Actions Inactive

Update using-paragraph-breaks.md

0de0437

Removed step 2 and updated wording on step 3.

BiancaPaw temporarily deployed to preview October 27, 2025 21:03 — with GitHub Actions Inactive

Update using-paragraph-breaks.md

afff983

updated instruction numbering

BiancaPaw temporarily deployed to preview October 27, 2025 21:04 — with GitHub Actions Inactive

Fix line endings and double spaces

8067e5d

Nateowami temporarily deployed to preview October 31, 2025 13:39 — with GitHub Actions Inactive

	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.

	3. Before generating a new draft, select Formatting Options.
	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".
	4. Select the options for quote styles to apply to the draft. The two options are "Automatic quote style" or "Straight quotes".

	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.

	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.

Uh oh!

Comments

Conversation

BiancaPaw commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

BiancaPaw commented Oct 24, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Nateowami left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nateowami Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

BiancaPaw Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Nateowami Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants