Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions CONTRIBUTOR.md
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!
20 changes: 20 additions & 0 deletions README.md
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Contributor Author

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


## Documentation

📖 **[Visit the full documentation](https://ai4curation.github.io/aidocs/)**

The complete guides, tutorials, and reference materials are available on our GitHub Pages site.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add link?

Copy link
Contributor Author

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


## About

This site provides practical, immediately integrable guides for:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:

Copy link
Contributor Author

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

- AI agents that work with existing GitHub repositories
- Plugins for existing chat UIs
- Workflows for ontology editing and curation

## Contributing

See [CONTRIBUTOR.md](CONTRIBUTOR.md) for information on how to contribute to this documentation.