Skip to content

Browser tool that scans proposal text against a transparent, editable catalog of high‑salience terms, then highlights matches and (optionally) shows rephrase/reframe suggestions with rationale and citations to support clearer, compliant writing.

License

Notifications You must be signed in to change notification settings

FritscheLab/grant-language-preflight

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grant Language Preflight (Transparent Catalog Edition)

An offline-first, single-file browser tool that highlights configured terms in proposal text and (optionally) shows rephrase / reframe suggestions with evidence notes and citations.

This repository is designed for GitHub Pages hosting and for transparent catalog maintenance (PR reviewable, versionable, and citable).


What this is (and is not)

This tool is a writing aid. It helps you:

  • identify jargon and high-salience terms,
  • replace abstract labels with operational, measurable language, and
  • keep a record of why a suggestion exists (rationale) and what sources support the general principle (citations).

This tool is not:

  • legal advice,
  • an official list of “banned words,”
  • a mechanism to misrepresent eligibility, populations, methods, or outcomes.

If a solicitation/FOA requires specific statutory language, use it.

Any example text (including the "Load Example" content in the UI) is entirely AI-generated for demonstration only; any resemblance to actual projects, proposals, people, or institutions is purely coincidental.


Quick start (local)

  1. Open docs/index.html in a modern browser.
  2. Paste text into Source Text.
  3. Toggle:
    • Show remessaging suggestions
    • Remember pasted text (local) (optional)
  4. Use Download JSON / Upload JSON in the Catalog panel to manage your term list.

Publish on GitHub Pages (recommended)

This repo is configured to publish from the /docs folder.

  1. Create a new GitHub repository and upload the contents of this zip.
  2. In GitHub:
    • Settings → Pages
    • Source: Deploy from a branch
    • Branch: main
    • Folder: /docs
  3. Save. Your site will be available at your GitHub Pages URL.

(See GitHub documentation on configuring a publishing source for Pages.)


Catalog transparency model

The catalog is stored at:

  • docs/catalog.default.json — the default term catalog (format v2)
  • docs/catalog.schema.json — JSON Schema for validation

Each catalog row can include:

  • keywords (semicolon-separated tokens/phrases)
  • tier ("1" or "2")
  • rephrase and reframe
  • evidence and rationale
  • citations (array of {title, url, note})

Editing workflow

  1. Download catalog JSON in the app (Catalog → Download JSON), or edit docs/catalog.default.json directly.
  2. Validate against docs/catalog.schema.json (optional).
  3. Commit changes with a clear message and update CHANGELOG.md for notable edits.

Licenses & citation

  • Code license: MIT (LICENSE)
  • Catalog data license: CC BY 4.0 (DATA_LICENSE.md)

Compliance and copyright notes (practical)

  • Citations increase transparency but do not grant permission to copy third‑party wording or tables.
  • Avoid re-hosting third-party PDFs unless you have permission; link instead.
  • Keep all proposal statements true, complete, and accurate.

See SOURCES.md for the small set of reference links used as general support for the writing approach.


Support / contributions

See CONTRIBUTING.md.

About

Browser tool that scans proposal text against a transparent, editable catalog of high‑salience terms, then highlights matches and (optionally) shows rephrase/reframe suggestions with rationale and citations to support clearer, compliant writing.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks