Skip to content

Commit

Permalink
chore(docs): update Shire documentation and resources
Browse files Browse the repository at this point in the history
Update the Shire documentation and resources, including:
- Improved documentation structure and links
- New Shire example projects and resources
- Bumped plugin version to 0.7.0

This commit enhances the accessibility and understanding of Shire's features and functionalities for users and developers.
  • Loading branch information
phodal committed Aug 29, 2024
1 parent 98b439e commit 1983319
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@
the Shire offers a straightforward AI Coding Agent Language
that enables communication between an LLM and control IDE for automated programming.

[Quick Start →](https://shire.phodal.com/)

[Shire Book: AI for software-engineering](https://aise.phodal.com/)
[Quick Start →](https://shire.phodal.com/) (Documentation)

> The concept of Shire originated from [AutoDev](https://github.com/unit-mesh/auto-dev), a subproject
> of [UnitMesh](https://unitmesh.cc/). In AutoDev, we designed an AI-driven IDE for developers that includes DevIns, the
Expand All @@ -34,7 +32,13 @@ Shire Data Architecture:

![Shire Data Architecture](docs/images/shire-data-flow.svg)

Documentation: [Shire AI Coding Agent Language](https://shire.phodal.com/)
Shire Resources

- Example projects:
- [Java example](https://github.com/shire-lang/shire-spring-java-demo)
- Documentation: [Shire AI Coding Agent Language](https://shire.phodal.com/)
- [Shire Book: AI for software-engineering](https://aise.phodal.com/) (Chinese only)
- [Shire.Run - the shareable AI coding agent](https://shire.run/)

## Demo Video

Expand Down
10 changes: 8 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,21 @@ Shire 提供了一种简便 AI 编码智能体语言,能够让大型语言模
AutoDev 中,我们设计了一个面向开发者的 AI 驱动集成开发环境(IDE),其中包括 Shire 的前身 DevIns。DevIns 旨在让用户能够为他们自己的
IDE 创建定制的 AI 代理,从而构建个性化的 AI 驱动开发环境。

Shire example:
Shire 示例:

![Shire Cheatsheet](images/shire-sheet.svg)

Shire Data Architecture:

![Shire Data Architecture](images/shire-data-flow.svg)

Here’s an overview of its main features and functionalities:
Shire Resources

- Example projects:
- [Java example](https://github.com/shire-lang/shire-spring-java-demo)
- Documentation: [Shire AI Coding Agent Language](https://shire.phodal.com/)
- [Shire Book: AI for software-engineering](https://aise.phodal.com/) (Chinese only)
- [Shire.Run - the shareable AI coding agent](https://shire.run/)

## Demo Video

Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pluginGroup = com.github.phodal.shire
pluginName = shire
pluginRepositoryUrl = https://github.com/phodal/shire
# SemVer format -> https://semver.org
pluginVersion = 0.6.0
pluginVersion = 0.7.0

# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
pluginSinceBuild = 232
Expand Down

0 comments on commit 1983319

Please sign in to comment.