An interactive web application that transforms the comprehensive "Generative AI Usage Documentation Checklist for Applied Research" into a user-friendly, dynamic experience.
- Interactive Navigation System: Browse through the three tiers (Foundations, Typical Components, Bleeding Edge)
- Guided Workflow: Step-by-step guidance for first-time users
- Progress Tracking: Mark checklist items as completed with local storage
- Search Functionality: Find specific topics or requirements quickly
- Real-World Examples: Practical examples for each documentation section
- Node.js (v14 or higher)
- npm or yarn
- Unzip the downloaded package
- Open a terminal and navigate to the unzipped directory
- Install dependencies:
npm install
# or
yarn install- Start the development server:
npm run dev
# or
yarn dev- Open your browser and navigate to
http://localhost:5173
To create a production build:
npm run build
# or
yarn buildThe built files will be in the dist directory and can be served by any static file server.
- Deployment to git-pages:
npm run deploy
# or
yarn deployThis will deploy the app to GitHub Pages. Make sure to set the base URL in vite.config.js to your repository name.
- Start with the Guided Workflow if you're new to AI documentation
- Browse the navigation menu to explore specific sections
- Use the search bar to find particular topics
- Check off items as you complete them to track your progress
- Explore examples to see how to implement each documentation element
This project is available for educational and research purposes.
Based on the "Generative AI Usage Documentation Checklist for Applied Research" document.