-
Notifications
You must be signed in to change notification settings - Fork 369
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from JoaoRodrigues/main
Add nicer webpage and some tooling to validate content.
- Loading branch information
Showing
12 changed files
with
366 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: deploy_page | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| permissions: | ||
| contents: write | ||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Configure Git Credentials | ||
| run: | | ||
| git config user.name github-actions[bot] | ||
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | ||
| - uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: 3.x | ||
| - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | ||
| - uses: actions/cache@v3 | ||
| with: | ||
| key: mkdocs-material-${{ env.cache_id }} | ||
| path: .cache | ||
| restore-keys: | | ||
| mkdocs-material- | ||
| - run: python -m pip install -r requirements.txt | ||
| - run: python mkindex.py README.md | ||
| - run: mkdocs gh-deploy --force |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| name: validate_url | ||
| on: # yamllint disable-line rule:truthy | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Configure Git Credentials | ||
| run: | | ||
| git config user.name github-actions[bot] | ||
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | ||
| - uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: 3.x | ||
| - run: python mkindex.py --validate-only README.md | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| .DS_Store | ||
| venv/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # How to build/update the website | ||
|
|
||
| ## Notes | ||
| - You should not have to use this on a regular basis. The repository is setup to | ||
| run the validation for each pull request and the deployment whenever you accept | ||
| a pull request or push a commit directly to the main branch. You should use this | ||
| to test changes locally. | ||
| - Your repository should be setup to serve pages from the gh-pages branch. | ||
|
|
||
| ## Requirements | ||
| - Python | ||
| - Git | ||
|
|
||
| ## Steps | ||
|
|
||
| ### Cloning the repository | ||
| ```bash | ||
| git clone https://github.com/eseckel/ai-for-grant-writing | ||
| ``` | ||
|
|
||
| ### Installing the framework | ||
| ```bash | ||
| cd ai-for-grant-writing | ||
|
|
||
| # Create a virtual environment not to mess with system Python | ||
| python3 -m venv venv | ||
| source venv/bin/activate | ||
|
|
||
| # Install requirements | ||
| python -m pip install -r requirements.txt | ||
|
|
||
| # Test | ||
| mkdocs serve # check browser for https://localhost:8000 | ||
|
|
||
| # To quit mkdocs serve do Ctrl-C | ||
| ``` | ||
|
|
||
| ### Deploying a new version of the website | ||
| ``` | ||
| source venv/bin/activate # You need the environment from the previous step | ||
| # After making changes to README.md | ||
| python3 mkindex.py | ||
| mkdocs serve # To check changes | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| toc_depth: 3 | ||
| --- | ||
| # AI for Grant Writing | ||
| A curated list of resources for using AI to develop more competitive grant applications. | ||
|
|
||
|
|
||
|
|
||
| ## Useful Services | ||
|
|
||
| | | Checks Spelling and Grammar | Text Generation | Translation | Mock Review | Image Generation | Free Tier | | ||
| | :--- | :---: | :---: | :---: | :---: | :---: | :---: | | ||
| | [ChatGPT](https://chat.openai.com) | x | x | x | x | x | x | | ||
| | [Bard](https://bard.google.com/) | x | x | x | x | | x | | ||
| | [Grok](https://grok.x.ai/) | x | x | x | x | | | | ||
| | [Copilot](https://copilot.microsoft.com/) | x | x | x | x | x | x | | ||
| | [Grammarly](https://www.grammarly.com/) | x | x | | x | | x | | ||
| | [Curie](https://www.aje.com/curie/) | x | | x | | | | | ||
| | [DeepL](https://www.deepl.com/translator) | | | x | | | x | | ||
| | [Midjourney](https://www.midjourney.com) | | | | | x | | | ||
| | [Firefly](https://www.adobe.com/products/firefly.html) | | | | | x | x | | ||
|
|
||
| ## Prompt Resources | ||
|
|
||
| ### Prompt Collections | ||
| - [85+ ChatGPT Prompts for Grant Writing](https://aihabit.net/chatgpt-prompts-for-grant-writing/#google_vignette) | ||
| - [ChatGPT Prompts For Academic Research Writing](https://clickup.com/templates/ai-prompts/research-writing) | ||
|
|
||
| ### Prompt Engineering | ||
| - [Google's Tips to enhance your prompt-engineering abilities](https://cloud.google.com/blog/products/application-development/five-best-practices-for-prompt-engineering) | ||
| - [Best practices for prompt engineering with OpenAI API](https://help.openai.com/en/articles/6654000-best-practices-for-prompt-engineering-with-openai-api) | ||
| - [Awesome GPT Prompt Engineering ](https://github.com/snwfdhmp/awesome-gpt-prompt-engineering) | ||
|
|
||
| ### Quick Prompts | ||
|
|
||
| #### To enhance text clarity | ||
| ``` | ||
| As a non-native English speaker, kindly help me revise the following text for improved understanding | ||
| and clarity. Please check for spelling and sentence structure errors and suggest alternatives. | ||
| ``` | ||
|
|
||
| ``` | ||
| What suggestions do you have to enhance the clarity of my text? | ||
| ``` | ||
|
|
||
| ``` | ||
| Please identify any parts of my writing that may be difficult for a lay audience to understand. | ||
| ``` | ||
|
|
||
| #### To make text more compelling | ||
| ``` | ||
| Please provide feedback on my writing style and how I can make it more persuasive and compelling | ||
| for the grant reviewer. | ||
| ``` | ||
| ``` | ||
| I’m trying to hook my reader with a strong introduction. Can you suggest a more captivating first | ||
| sentence to draw them in from the start? | ||
| ``` | ||
| #### To improve structure and flow of text | ||
| ``` | ||
| I want to improve the overall structure of my Specific Aims. What tips do you have to structure it | ||
| more effectively?” | ||
| ``` | ||
| #### To better align with the funding agency’s mission | ||
| ``` | ||
| I’m working on a postdoctoral fellowship application. Can you please review my closing paragraph | ||
| and suggest ways to better align it with the American Heart Association’s mission? | ||
| ``` | ||
| #### To better align text with review criteria | ||
| ``` | ||
| I am applying to <insert fellowship name>. Please provide me feedback on how well I am | ||
| addressing this review criteria: <insert specific review criteria>, and suggestions for what I am | ||
| missing and how I can improve. | ||
| ``` | ||
|
|
||
| ## Grant Writing-Specific Resources | ||
| - [Best Kept Secrets to Winning Grants](https://www.nature.com/articles/545399a) | ||
| - [The Anatomy of a Specific Aims Page](https://biosciencewriters.com/NIH-Grant-Applications-The-Anatomy-of-a-Specific-Aims-Page.aspx) | ||
| - [R01 Countdown: Tools for Writing Concise and Compelling Grants](https://purl.stanford.edu/yy394gb6954) | ||
|
|
||
| # Contributing | ||
|
|
||
| We encourage and welcome contributions! Please have a look at the [contribution guidelines](https://github.com/eseckel/ai-for-grant-writing/blob/main/CONTRIBUTING.md) first. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <li class="md-nav__item"> | ||
| <a href="{{ toc_item.url }}" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| {{ toc_item.title }} | ||
| </span> | ||
| </a> | ||
|
|
||
| <!-- Table of contents list --> | ||
| {% if toc_item.children %} | ||
| <nav class="md-nav" aria-label="{{ toc_item.title | striptags }}"> | ||
| <ul class="md-nav__list"> | ||
| {% for toc_item in toc_item.children %} | ||
| {% if not page.meta.toc_depth or toc_item.level <= page.meta.toc_depth %} | ||
| {% include "partials/toc-item.html" %} | ||
| {% endif %} | ||
| {% endfor %} | ||
| </ul> | ||
| </nav> | ||
| {% endif %} | ||
| </li> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| /* Hide redundant titles */ | ||
| .md-typeset h1, | ||
| label.md-nav__title { | ||
| display: none; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| site_name: AI for Grant Writing | ||
| site_url: https://awesome-python.com | ||
| site_description: A curated list of resources for using AI to develop more competitive grant applications. | ||
| site_author: Elizabeth Seckel | ||
| repo_name: eseckel/ai-for-grant-writing | ||
| repo_url: https://github.com/eseckel/ai-for-grant-writing | ||
| theme: | ||
| name: material | ||
| icon: | ||
| repo: fontawesome/brands/github | ||
| palette: | ||
| primary: purple | ||
| accent: blue grey | ||
| features: | ||
| - toc.follow | ||
| - toc.integrate | ||
| - content.code.copy | ||
| markdown_extensions: | ||
| - tables | ||
| custom_dir: docs/overrides | ||
| extra_css: | ||
| - stylesheets/extra.css | ||
| plugins: | ||
| - exclude: | ||
| glob: | ||
| - "*.txt" |
Oops, something went wrong.