Merge pull request #33 from ks6088ts-labs/feature/issue-32_update-docs

update docs

Author: ks6088ts

README.md

@@ -6,75 +6,8 @@
 
 # template-langgraph
 
-This is a template repository for Python
+A comprehensive LangGraph template for building AI Agents with Python.
 
-## Prerequisites
+## Documentation
 
-- [Python 3.10+](https://www.python.org/downloads/)
-- [uv](https://docs.astral.sh/uv/getting-started/installation/)
-- [GNU Make](https://www.gnu.org/software/make/)
-
-## Development instructions
-
-### Local development
-
-Use Makefile to run the project locally.
-
-```shell
-# help
-make
-
-# install dependencies for development
-make install-deps-dev
-
-# run tests
-make test
-
-# run CI tests
-make ci-test
-```
-
-### Docker development
-
-```shell
-# build docker image
-make docker-build
-
-# run docker container
-make docker-run
-
-# run CI tests in docker container
-make ci-test-docker
-```
-
-## Deployment instructions
-
-### Docker Hub
-
-To publish the docker image to Docker Hub, you need to [create access token](https://app.docker.com/settings/personal-access-tokens/create) and set the following secrets in the repository settings.
-
-```shell
-gh secret set DOCKERHUB_USERNAME --body $DOCKERHUB_USERNAME
-gh secret set DOCKERHUB_TOKEN --body $DOCKERHUB_TOKEN
-```
-
-### Azure Static Web Apps
-
-```shell
-RESOURCE_GROUP_NAME=your-resource-group-name
-SWA_NAME=your-static-web-app-name
-
-# Create a static app
-az staticwebapp create --name $SWA_NAME --resource-group $RESOURCE_GROUP_NAME
-
-# Retrieve the API key
-AZURE_STATIC_WEB_APPS_API_TOKEN=$(az staticwebapp secrets list --name $SWA_NAME --query "properties.apiKey" -o tsv)
-
-# Set the API key as a GitHub secret
-gh secret set AZURE_STATIC_WEB_APPS_API_TOKEN --body $AZURE_STATIC_WEB_APPS_API_TOKEN
-```
-
-Refer to the following links for more information:
-
-- [Deploying to Azure Static Web App](https://docs.github.com/en/actions/use-cases-and-examples/deploying/deploying-to-azure-static-web-app)
-- [Create a static web app: `az staticwebapp create`](https://learn.microsoft.com/en-us/cli/azure/staticwebapp?view=azure-cli-latest#az-staticwebapp-create)
+See the [documentation](https://ks6088ts-labs.github.io/template-langgraph/) for more information.

docs/deployment.md

@@ -0,0 +1,31 @@
+## Deployment instructions
+
+### Docker Hub
+
+To publish the docker image to Docker Hub, you need to [create access token](https://app.docker.com/settings/personal-access-tokens/create) and set the following secrets in the repository settings.
+
+```shell
+gh secret set DOCKERHUB_USERNAME --body $DOCKERHUB_USERNAME
+gh secret set DOCKERHUB_TOKEN --body $DOCKERHUB_TOKEN
+```
+
+### Azure Static Web Apps
+
+```shell
+RESOURCE_GROUP_NAME=your-resource-group-name
+SWA_NAME=your-static-web-app-name
+
+# Create a static app
+az staticwebapp create --name $SWA_NAME --resource-group $RESOURCE_GROUP_NAME
+
+# Retrieve the API key
+AZURE_STATIC_WEB_APPS_API_TOKEN=$(az staticwebapp secrets list --name $SWA_NAME --query "properties.apiKey" -o tsv)
+
+# Set the API key as a GitHub secret
+gh secret set AZURE_STATIC_WEB_APPS_API_TOKEN --body $AZURE_STATIC_WEB_APPS_API_TOKEN
+```
+
+Refer to the following links for more information:
+
+- [Deploying to Azure Static Web App](https://docs.github.com/en/actions/use-cases-and-examples/deploying/deploying-to-azure-static-web-app)
+- [Create a static web app: `az staticwebapp create`](https://learn.microsoft.com/en-us/cli/azure/staticwebapp?view=azure-cli-latest#az-staticwebapp-create)

docs/development.md

@@ -0,0 +1,39 @@
+## Development instructions
+
+### Local development
+
+Use Makefile to run the project locally.
+
+```shell
+# help
+make
+
+# install dependencies for development
+make install-deps-dev
+
+# run tests
+make test
+
+# run CI tests
+make ci-test
+```
+
+### Testing
+
+```shell
+# Run all tests for AI agents
+bash scripts/test_all.sh
+```
+
+### Docker development
+
+```shell
+# build docker image
+make docker-build
+
+# run docker container
+make docker-run
+
+# run CI tests in docker container
+make ci-test-docker
+```

docs/faq.md

@@ -0,0 +1,21 @@
+## FAQ
+
+### Docker Compose で Elasticsearch を起動できない
+
+**現象:**
+
+WSL2 上で `docker compose up elasticsearch` を実行した際に、以下のエラーが発生する
+
+`java.lang.IllegalStateException: failed to obtain node locks, tried [/usr/share/elasticsearch/data]; maybe these locations are not writable or multiple nodes were started on the same data path?`
+
+**原因:**
+
+Elasticsearch がデータディレクトリ（/usr/share/elasticsearch/data）にロックファイルを作成できないことを示しています。
+
+**対処方法:**
+
+ディレクトリの権限を修正するために、以下のコマンドを実行してください。
+
+```shell
+sudo chown -R 1000:1000 ./assets/es_data
+```