AI Readiness Primer

A primer resource for AI readiness in the community, hosted as a Quarto website via GitHub Pages.

About

This repository hosts resources consolidated into a primer for community use. The site is built using Quarto and automatically published to GitHub Pages.

View the Site

The published site is available at: https://esipfed.github.io/ai-readiness-primer/

Local Development

Using GitHub Codespaces (Recommended)

The easiest way to get started is using GitHub Codespaces, which provides a pre-configured development environment:

1. Click the "Code" button on the repository page
2. Select "Codespaces" tab
3. Click "Create codespace on main"

The development container will automatically set up Quarto and all necessary tools. Once ready, you can use the terminal to run Quarto commands.

Local Setup

Prerequisites

• Quarto installed on your system

Building Locally

To preview the site locally:

quarto preview

To render the site:

quarto render

The rendered site will be in the _site directory.

Contributing

Contributions are welcome! To contribute:

1. Fork the repository
2. Create a new branch for your changes
3. Make your changes to the .qmd files
4. Test locally with quarto preview
5. Submit a pull request

Project Structure

• _quarto.yml - Quarto project configuration
• index.qmd - Homepage content
• about.qmd - About page content
• styles.css - Custom CSS styles
• .github/workflows/publish.yml - GitHub Actions workflow for publishing

Deployment

The site is automatically built and deployed to GitHub Pages when changes are pushed to the main branch. The workflow uses GitHub Actions and the official Quarto action.