diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..42b58c8 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,9 @@ +# FAQ + +## What is this project? + +This site collects guidance for using AI to assist with curation workflows. + +## How can I contribute? + +Contributions are welcome via pull requests on the project's GitHub repository. diff --git a/docs/glossary.md b/docs/glossary.md index e369a59..05ffc82 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -2,7 +2,15 @@ ## AI Agent -An agent is a program that allows AI models to call [tools](#tool) to achieve some objective. +An agent is a program that allows AI models to call [tools](#tool) to achieve some objective. + +## Tool + +A software capability or utility that an AI agent can invoke to perform a specific task, such as reading files, running code, or querying a service. + +## Agentic Coding Tool + +An environment or application that enables an AI system to modify code or other files using natural language commands. ## CBORG diff --git a/docs/how-tos/instruct-github-agent.md b/docs/how-tos/instruct-github-agent.md index cf58e8e..a9c6bea 100644 --- a/docs/how-tos/instruct-github-agent.md +++ b/docs/how-tos/instruct-github-agent.md @@ -1,6 +1,6 @@ # AI Instructors Guide: GitHub Agents -This is a guide for instructing the [AI agent](../glossary.md#ai-agent) that lives in GitHub repo. This assumes your AI controller has [set up [GitHub actions](../glossary.md#github-actions)](set-up-github-actions) in your repo. +This is a guide for instructing the [AI agent](../glossary.md#ai-agent) that lives in GitHub repo. This assumes your AI controller has [set up [GitHub actions](../glossary.md#github-actions)](set-up-github-actions.md) in your repo. ## How it works diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..8074204 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1 @@ +/* Additional customization styles */