From 03cb33ba7b065009e90b5b34df47935b9b33cac3 Mon Sep 17 00:00:00 2001 From: Danielle Jenkins Date: Wed, 12 Mar 2025 14:52:36 -0700 Subject: [PATCH] Rename doc server to stdio server --- CLAUDE.md | 2 +- Cargo.toml | 4 ++-- README.md | 2 +- docs/development.md | 2 +- examples/client.rs | 4 ++-- src/bin/cratedocs.rs | 2 +- src/bin/{doc_server.rs => stdio_server.rs} | 0 7 files changed, 8 insertions(+), 8 deletions(-) rename src/bin/{doc_server.rs => stdio_server.rs} (100%) diff --git a/CLAUDE.md b/CLAUDE.md index b9b244b..274b270 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,7 +2,7 @@ ## Build Commands - Build project: `cargo build` -- Run STDIN/STDOUT server: `cargo run --bin doc-server` +- Run STDIN/STDOUT server: `cargo run --bin stdio-server` - Run HTTP/SSE server: `cargo run --bin axum-docs` - Run tests: `cargo test` - Run specific test: `cargo test test_name` diff --git a/Cargo.toml b/Cargo.toml index a6dbc74..9944d5e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -48,8 +48,8 @@ path = "src/bin/cratedocs.rs" # Keep existing binaries for backward compatibility [[bin]] -name = "doc-server" -path = "src/bin/doc_server.rs" +name = "stdio-server" +path = "src/bin/stdio_server.rs" [[bin]] name = "http-sse-server" diff --git a/README.md b/README.md index 917939c..3ce9602 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ For backward compatibility, you can still use the original binaries: ```bash # STDIN/STDOUT Mode -cargo run --bin doc-server +cargo run --bin stdio-server # HTTP/SSE Mode cargo run --bin axum-docs diff --git a/docs/development.md b/docs/development.md index 304f494..dfefc11 100644 --- a/docs/development.md +++ b/docs/development.md @@ -12,7 +12,7 @@ The server consists of several key components: - Implements caching to avoid redundant API requests 2. **Transport Implementations**: - - STDIN/STDOUT server (`src/bin/doc_server.rs`) + - STDIN/STDOUT server (`src/bin/stdio_server.rs`) - HTTP/SSE server (`src/bin/axum_docs.rs`) 3. **Utilities**: diff --git a/examples/client.rs b/examples/client.rs index c43165a..d1040c7 100644 --- a/examples/client.rs +++ b/examples/client.rs @@ -6,9 +6,9 @@ use tokio::io::{self, AsyncBufReadExt, AsyncWriteExt, BufReader}; // Simple example client for interacting with the doc server via stdin/stdout async fn stdio_client() -> Result<()> { - // Start the doc-server in a separate process + // Start the stdio-server in a separate process let mut child = tokio::process::Command::new("cargo") - .args(["run", "--bin", "doc-server"]) + .args(["run", "--bin", "stdio-server"]) .stdin(std::process::Stdio::piped()) .stdout(std::process::Stdio::piped()) .spawn()?; diff --git a/src/bin/cratedocs.rs b/src/bin/cratedocs.rs index c0ae922..27faa77 100644 --- a/src/bin/cratedocs.rs +++ b/src/bin/cratedocs.rs @@ -48,7 +48,7 @@ async fn main() -> Result<()> { async fn run_stdio_server(debug: bool) -> Result<()> { // Set up file appender for logging - let file_appender = RollingFileAppender::new(Rotation::DAILY, "logs", "doc-server.log"); + let file_appender = RollingFileAppender::new(Rotation::DAILY, "logs", "stdio-server.log"); // Initialize the tracing subscriber with file logging let level = if debug { tracing::Level::DEBUG } else { tracing::Level::INFO }; diff --git a/src/bin/doc_server.rs b/src/bin/stdio_server.rs similarity index 100% rename from src/bin/doc_server.rs rename to src/bin/stdio_server.rs