-
Notifications
You must be signed in to change notification settings - Fork 2
Add README.md and CONTRIBUTOR.md documentation files #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Contributing to AI4Curators Documentation | ||
|
|
||
| Thank you for your interest in contributing to the AI4Curators documentation! This project uses MkDocs to build documentation that helps curators and maintainers of knowledge bases integrate AI into their workflows. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| ### Quick Edits | ||
|
|
||
| The easiest way to contribute is to use GitHub's built-in editor: | ||
|
|
||
| 1. **Browse the documentation** at https://ai4curation.github.io/aidocs/ | ||
| 2. **Click the edit button** (✏️) on any page you'd like to improve | ||
| 3. **Make your changes** directly in the GitHub editor | ||
| 4. **Submit a pull request** with your improvements | ||
|
|
||
| Each page in the documentation has an edit button that takes you directly to the source file on GitHub. | ||
|
|
||
| ### Local Development | ||
|
|
||
| For more substantial changes, you can work locally: | ||
|
|
||
| 1. **Fork and clone** this repository | ||
| 2. **Install dependencies**: | ||
| ```bash | ||
| pip install -e . | ||
| ``` | ||
| 3. **Start the development server**: | ||
| ```bash | ||
| mkdocs serve | ||
| ``` | ||
| 4. **Edit files** in the `docs/` directory | ||
| 5. **Preview changes** at http://localhost:8000 | ||
| 6. **Submit a pull request** when ready | ||
|
|
||
| ## Content Guidelines | ||
|
|
||
| - **Focus on practical guides** that can be immediately integrated into existing workflows | ||
| - **Include examples** and step-by-step instructions | ||
| - **Keep content current** with the latest AI tools and techniques | ||
| - **Use clear, concise language** suitable for both technical and non-technical users | ||
|
|
||
| ## File Structure | ||
|
|
||
| - `docs/` - Main documentation content | ||
| - `docs/how-tos/` - Step-by-step guides | ||
| - `docs/tutorials/` - Longer-form learning materials | ||
| - `docs/reference/` - Reference documentation | ||
| - `mkdocs.yml` - Site configuration | ||
|
|
||
| ## Questions? | ||
|
|
||
| If you have questions about contributing, please: | ||
| - Open an issue in this repository | ||
| - Check existing issues for similar questions | ||
| - Review the documentation at https://ai4curation.github.io/aidocs/ | ||
|
|
||
| We appreciate all contributions, from fixing typos to adding new guides! | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,20 @@ | ||||||
| # AI4Curators - AI Guides | ||||||
|
|
||||||
| This repository contains documentation for AI for curation, providing practical guides for curators and maintainers of knowledge bases to integrate AI into their workflows. | ||||||
|
||||||
| This repository contains documentation for AI for curation, providing practical guides for curators and maintainers of knowledge bases to integrate AI into their workflows. | |
| This repository contains documentation about using AI to assist with curation, providing practical guides for curators and maintainers of knowledge bases to integrate AI into their workflows. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated with the suggested text in commit 59a87c6
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add link?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added link to GitHub Pages site in commit 59a87c6
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| This site provides practical, immediately integrable guides for: | |
| This site provides practical guides that show how you can quickly integrate the following into your workflows: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated with the suggested text in commit 59a87c6
Uh oh!
There was an error while loading. Please reload this page.