Skip to content

Commit a80b34b

Browse files
committed
Remove references to docs/ directory after documentation consolidation
1 parent 9699176 commit a80b34b

File tree

132 files changed

+1668
-1355
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+1668
-1355
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@ on:
66
- main
77
paths-ignore:
88
- '**.md'
9-
- 'docs/**'
109
- 'uim-docs/**'
1110
- '.github/workflows/docs.yml'
1211
pull_request:
1312
branches:
1413
- main
1514
paths-ignore:
1615
- '**.md'
17-
- 'docs/**'
1816
- 'uim-docs/**'
1917
- '.github/workflows/docs.yml'
2018
workflow_dispatch:

.github/workflows/docs.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ on:
1010
- main
1111
paths:
1212
- 'uim-docs/**'
13-
- 'docs/**'
1413
- '.github/workflows/docs.yml'
1514
- 'pyproject.toml'
1615
- 'poetry.lock'
@@ -19,7 +18,6 @@ on:
1918
- main
2019
paths:
2120
- 'uim-docs/**'
22-
- 'docs/**'
2321
- '.github/workflows/docs.yml'
2422
- 'pyproject.toml'
2523
- 'poetry.lock'

INSTRUCTIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,4 @@ These instructions assume you’re using the Cline VS Code extension with CRCT v
9696
- The LLM handles most commands (`generate-keys`, `set_char`, etc.) automatically.
9797
- For custom projects, populate `src/` and `docs/` before starting.
9898

99-
Questions? Open an issue on GitHub!
99+
Questions? Open an issue on GitHub!

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,4 @@
198198
distributed under the License is distributed on an "AS IS" BASIS,
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201-
limitations under the License.
201+
limitations under the License.

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
<div align="center">
2-
<img src="docs/images/abstract.png" alt="UIM Protocol Logo">
2+
<img src="https://synaptiai.github.io/uim-protocol/assets/images/abstract.png" alt="UIM Protocol Logo">
33
<h1>The Unified Intent Mediator Protocol</h1>
44
<p>A standardized framework for AI agents to interact with web services through well-defined intents</p>
55
</div>
66

77
## Getting Started
88

9-
1. Get familiar with the [concepts and motivations](docs/specification/uim-concept.md) behind the UIM protocol
10-
2. Dive into the [technical exploration](docs/specification/uim-technical-exploration.md) to understand the details and technical choices
11-
3. Explore the [prototype implementations](implementations/README.md) to see the UIM protocol in action
9+
1. Get familiar with the [concepts and motivations](https://synaptiai.github.io/uim-protocol/specification/) behind the UIM protocol
10+
2. Explore the [prototype implementations](https://synaptiai.github.io/uim-protocol/prototypes/) to see the UIM protocol in action
1211

1312
## Development Setup
1413

@@ -31,7 +30,7 @@ This project uses [Poetry](https://python-poetry.org/) for dependency management
3130
```bash
3231
poetry install
3332
```
34-
33+
3534
This will create a virtual environment and install all dependencies.
3635

3736
3. Activate the virtual environment:
@@ -77,7 +76,7 @@ We're inviting developers, AI providers, service operators, and tech/AI enthusia
7776

7877
### How to Contribute
7978

80-
1. **Review the Draft Proposal**: Check out the [draft specification](docs/specification/uim-specification.txt) and explore the protocol's design and implementation.
79+
1. **Review the Draft Proposal**: Check out the [draft specification](https://synaptiai.github.io/uim-protocol/specification/uim-specification.txt) and explore the protocol's design and implementation.
8180
2. **Join the Discussion**: Start a conversation in the [Discussions](https://github.com/synaptiai/uim-protocol/discussions) tab. We'd love to hear your thoughts on the protocol's design, potential use cases, or any concerns.
8281
3. **Raise Issues**: Found a bug or have suggestions? Open an [Issue](https://github.com/synaptiai/uim-protocol/issues) to let us know or contribute directly by submitting a Pull Request. See our [Contributing Guidelines](CONTRIBUTING.md) for more information.
8382
4. **Share the Word**: Help us spread the word about the UIM protocol by sharing this repository with your network. Write a blog post, tweet, or share the project with your colleagues. We appreciate your support!
@@ -106,16 +105,17 @@ The UIM Protocol supports multiple architectural approaches:
106105

107106
```
108107
uim-protocol/
109-
├── docs/ # Documentation
110-
│ ├── specification/ # Protocol specifications
111-
│ ├── images/ # Documentation images
112-
│ └── api/ # API documentation
113108
├── implementations/ # Reference implementations
114109
│ ├── centralized-discovery-service/
115110
│ ├── uim-mock-agent/
116111
│ └── uim-mock-webservice/
117112
├── examples/ # Usage examples and demos
118-
├── uim-docs/ # MkDocs documentation source
113+
├── uim-docs/ # Documentation
114+
│ ├── docs/ # Documentation source files
115+
│ │ ├── specification/ # Protocol specifications
116+
│ │ ├── assets/ # Documentation assets (images, etc.)
117+
│ │ └── reference/ # API reference documentation
118+
│ └── site/ # Generated documentation site
119119
├── pyproject.toml # Poetry configuration
120120
└── poetry.lock # Poetry lock file
121121
```
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
DATABASE_URL=postgresql://user:password@localhost/uim_db
2-
LOG_LEVEL=INFO
2+
LOG_LEVEL=INFO

implementations/centralized-discovery-service/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ RUN pip install --no-cache-dir -r requirements.txt
88

99
COPY . .
1010

11-
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]
11+
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]

implementations/centralized-discovery-service/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ services:
1919
- db_data:/var/lib/postgresql/data
2020

2121
volumes:
22-
db_data:
22+
db_data:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# pytest.ini
22

33
[pytest]
4-
asyncio_default_fixture_loop_scope = function
4+
asyncio_default_fixture_loop_scope = function

implementations/centralized-discovery-service/scripts/setup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ export DATABASE_URL='postgresql://user:password@localhost/uim_db'
2121
# alembic upgrade head # Uncomment if using Alembic for migrations
2222

2323
# Notify the user
24-
echo "Setup complete. You can now run the application using 'uvicorn app.main:app --reload'."
24+
echo "Setup complete. You can now run the application using 'uvicorn app.main:app --reload'."

0 commit comments

Comments
 (0)