Jump to content

Righting Sentences Release Notes - 4.0: Difference between revisions

From Saxton Publishing Technical Documentation
← Older edit
Saxtonmd77 (talk | contribs)
Bureaucrats, Interface administrators, Administrators
216 edits
 
(7 intermediate revisions by the same user not shown)
Line 15: Line 15:


'''Landing Page Templates:'''
'''Landing Page Templates:'''
* '''Locations''' - Create global offices and delivery centers pages with proper structure
* '''Locations''' - Creates pages for global offices and delivery centers
* '''Services''' - Build service overview pages with capabilities, proof points, and outcomes
* '''Services''' - Builds pages for the overview of services
* '''Industries''' - Generate industry overview or specialization pages
* '''Industries''' - Generates pages for industries or specializations
* '''Leadership''' - Draft leadership team introductions that build credibility
* '''Leadership''' - Drafts pages for leadership team members
* '''Clients''' - Create client portfolio pages with testimonials and case study links
* '''Clients''' - Creates a client portfolio


'''Case Study Templates:'''
'''Case Study Templates:'''
* '''Case Study (PPT)''' - 7-slide PowerPoint structure with speaker notes suggestions
* '''Case Study (PPT)''' - Single-page PPT
* '''Case Study (Website)''' - SEO-optimized web case study with metrics and storytelling
* '''Case Study (Website)''' - SEO-optimized web case study with KPIs


All templates automatically use Google Gemini for optimal results and integrate seamlessly with the two-pass editorial system.
All templates use Google Gemini.


=== Quick Actions ===
=== Quick Actions ===
One-click text transformations that work on the previous AI response:
Edit the previous response in one click:


* '''Make it shorter''' - Condense content to approximately 50% of original length
* '''Make it shorter''' - Condenses content to approximately 50% of the original length
* '''Make it more formal''' - Increase professional tone and sophistication
* '''Make it more formal''' - Increases professional tone
* '''Simplify this''' - Make content clearer and more accessible
* '''Simplify this''' - Clarifie content
* '''Expand on this''' - Add detail, examples, and elaboration
* '''Expand on this''' - Adds


Quick actions execute immediately without requiring additional user input.
Quick actions do not require additional prompts.


=== Editorial Insights ===
=== Editorial Insights ===
A new dashboard showing your personal editorial analytics:
A new dashboard showing the user's editorial analytics:


* '''Total Messages''' - Number of messages processed through the editorial system
* '''Total Messages''' - Number of messages processed through the editorial system
* '''Pass Rate''' - Percentage of AI responses that passed without violations
* '''Pass Rate''' - Percentage of AI responses that passed without violations
* '''Top Violations''' - Most common AI patterns detected in your conversations
* '''Top Violations''' - Most common AI patterns detected in conversations
* '''Recent Corrections''' - Examples of recent editorial improvements
* '''Recent Corrections''' - Examples of recent system corrections


This feature helps users understand how the two-pass system works and which AI patterns are most commonly corrected.
This feature helps users understand how the two-pass system works and which AI patterns are most commonly corrected from their prompts. However, the insights are not necessarily indicative of how the system is functioning as a whole.


=== Conversation Export ===
=== Conversation Export ===
Export your conversations for documentation or backup:
Export conversations for documentation or backup:


* '''Markdown format''' - Clean, formatted text suitable for documentation
* '''Markdown format''' - For documentation
* '''JSON format''' - Structured data for programmatic use or archival
* '''JSON format''' - Structured data


== Technical Improvements ==
== Technical Improvements ==
Line 57: Line 57:
=== New Components ===
=== New Components ===
* <code>template_registry.py</code> - Template loading and resolution
* <code>template_registry.py</code> - Template loading and resolution
* <code>editorial_insights.py</code> - Statistics computation (pure functions, no DB deps)
* <code>editorial_insights.py</code> - Statistics computation
* <code>rate_limiter.py</code> - Request rate limiting
* <code>rate_limiter.py</code> - Request rate limiting
* <code>logging_config.py</code> - Structured logging configuration
* <code>logging_config.py</code> - Structured logging configuration
* <code>InsightsPage.jsx</code> - Editorial insights UI component
* <code>InsightsPage.jsx</code> - Editorial analyitcs UI component


=== Architecture ===
=== Architecture ===
* Templates defined in <code>templates.md</code> for easy editing
* Templates are defined in <code>templates.md</code>
* Template prompts inject into both Pass 1 and Pass 2 of the editorial system
* Template prompts are injected into both passes of the editorial system
* Quick actions automatically prepend context about the previous response
* Quick actions make fast corrections to the previous response
* Insights computed per-user from Firestore <code>editorial_logs</code> collection
* Analytics are computed based on the user's data from Firestore <code>editorial_logs</code>


=== Testing Infrastructure ===
=== Testing Infrastructure ===
* pytest configuration for backend tests
* pytest configuration for backend tests
* Vitest setup for frontend component testing
* Vitest setup for frontend component testing
* Development dependencies separated into <code>requirements-dev.txt</code>
* Development dependencies are separated into <code>requirements-dev.txt</code>
 
== Upgrade Notes ==
 
=== For Users ===
No action required. New features are available immediately after deployment.
 
=== For Administrators ===
* The <code>/templates</code> endpoint is now available for template listing
* The <code>/insights</code> endpoint returns per-user editorial statistics
* Template-based requests automatically use Gemini regardless of selected model


== Known Limitations ==
== Known Limitations ==


* Templates are currently read-only (no custom template creation yet)
* Quick actions require at least one previous assistant message in the conversation
* Editorial insights are limited to the most recent 100 messages per user
* Editorial insights are limited to the most recent 100 messages per user
 
* The system will periodically drop a word in the response, requiring closer editing
== Coming Soon ==
 
* Custom user templates
* BigQuery integration for aggregated editorial analytics
* A/B testing framework for prompt variants


----
----

Latest revision as of 19:34, 6 February 2026

Righting Sentences v4.0 Release Notes

Release Date: 6 February 2026

Production URL: https://righting-sentences-573737403792.us-east1.run.app/

Overview

Righting Sentences v4.0 includes content creation tools with Prompt Templates and Quick Actions, along with an Editorial Insights dashboard that shows how the two-pass editorial system improves writing. This release also adds the ability to export conversations in some file formats.

Highlights

Prompt Templates

Pre-built templates for professional content creation, optimized for B2B marketing use cases.

Landing Page Templates:

  • Locations - Creates pages for global offices and delivery centers
  • Services - Builds pages for the overview of services
  • Industries - Generates pages for industries or specializations
  • Leadership - Drafts pages for leadership team members
  • Clients - Creates a client portfolio

Case Study Templates:

  • Case Study (PPT) - Single-page PPT
  • Case Study (Website) - SEO-optimized web case study with KPIs

All templates use Google Gemini.

Quick Actions

Edit the previous response in one click:

  • Make it shorter - Condenses content to approximately 50% of the original length
  • Make it more formal - Increases professional tone
  • Simplify this - Clarifie content
  • Expand on this - Adds

Quick actions do not require additional prompts.

Editorial Insights

A new dashboard showing the user's editorial analytics:

  • Total Messages - Number of messages processed through the editorial system
  • Pass Rate - Percentage of AI responses that passed without violations
  • Top Violations - Most common AI patterns detected in conversations
  • Recent Corrections - Examples of recent system corrections

This feature helps users understand how the two-pass system works and which AI patterns are most commonly corrected from their prompts. However, the insights are not necessarily indicative of how the system is functioning as a whole.

Conversation Export

Export conversations for documentation or backup:

  • Markdown format - For documentation
  • JSON format - Structured data

Technical Improvements

New Components

  • template_registry.py - Template loading and resolution
  • editorial_insights.py - Statistics computation
  • rate_limiter.py - Request rate limiting
  • logging_config.py - Structured logging configuration
  • InsightsPage.jsx - Editorial analyitcs UI component

Architecture

  • Templates are defined in templates.md
  • Template prompts are injected into both passes of the editorial system
  • Quick actions make fast corrections to the previous response
  • Analytics are computed based on the user's data from Firestore editorial_logs

Testing Infrastructure

  • pytest configuration for backend tests
  • Vitest setup for frontend component testing
  • Development dependencies are separated into requirements-dev.txt

Known Limitations

  • Editorial insights are limited to the most recent 100 messages per user
  • The system will periodically drop a word in the response, requiring closer editing

Righting Sentences is developed by Saxton Publishing.

Retrieved from "https://docs.saxtonpublishing.com/index.php?title=Righting_Sentences_Release_Notes_-_4.0&oldid=193"