Skip to content

Readme peer review #2

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
kleinffm wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Readme peer review #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc90b15
revise split step
kleinffm Jul 14, 2025
650180e
revise reporting issues google doc step
kleinffm Jul 14, 2025
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ We use `module.adoc` as the example name for your Asciidoc file.
1. In the prompt window, use the `+` button to upload the Vale output file (`module.vale.txt`) and the numbered version of the original file (`module.adoc.numbered.txt`).
1. Enter a brief prompt, for example, `Let's Go!`, and then press Enter.
The system outputs explanations and suggestions for the issues in your input.
1. Optional: If the assistant proposes breaking up the module, enter a follow-on prompt, such as `Output the content of the split modules`. The assistant outputs the split modules and a snippet for including tham in the assembly. **You must verify that the new content matches the content of the existing module**.
1. If the assistant proposes that you split the module, enter an additional prompt, such as `Split this content into multiple modules`, to have the assistant generate the modules and snippet to include them in the assembly. **You must verify that the new content matches the content of the existing module**.
1. Start a new thread with the Gem to work on another file.

## Reporting issues

If you report issues, please include both files that you uploaded to the Gem and also the thread log.

1. To get a thread log, click the **Share** button under the last response in the thread, and select **Export to Docs**.![Share](sharebutton.png).
1. Go to [Google Docs](http://docs.google.com) to find the log as a Google Doc.
1. When the "New document created" message pops up, select **Open Doc**, or go to [Google Docs](http://docs.google.com) to find the log as a Google Doc.
1. In the **General access** section of the **Share** menu for the Google Doc, select "Red Hat" so anyone with the link can view the document, then copy and send the link with the issue.