From 1bc1a5f92a50601c4ef520f8c0114a2130758af3 Mon Sep 17 00:00:00 2001 From: Zach Giordano Date: Mon, 9 Sep 2024 14:45:11 -0400 Subject: [PATCH] Fix reference link. Add Makefile docs serve command --- Makefile | 4 ++++ README.md | 2 ++ docs/griptape-framework/structures/configs.md | 2 +- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 1db428b2cf..301145a09b 100644 --- a/Makefile +++ b/Makefile @@ -79,6 +79,10 @@ check/spell: docs: ## Build documentation. @poetry run mkdocs build +.PHONY: docs/serve +docs/serve: ## Serve documentation. + @poetry run mkdocs serve + .DEFAULT_GOAL := help .PHONY: help help: ## Print Makefile help text. diff --git a/README.md b/README.md index 95f6326dd4..c35eb60374 100644 --- a/README.md +++ b/README.md @@ -203,6 +203,8 @@ Run `make test/unit` to execute the test suite locally. Run `make docs` to build the documentation locally. +Run `make serve` to serve the documentation locally. + 5. **Code Checks:** Griptape a variety of tools to enforce code quality and style. Your code must pass all checks before it can be merged. Run `make check` to run all code checks locally. diff --git a/docs/griptape-framework/structures/configs.md b/docs/griptape-framework/structures/configs.md index 1cd8b03068..e192af79d2 100644 --- a/docs/griptape-framework/structures/configs.md +++ b/docs/griptape-framework/structures/configs.md @@ -5,7 +5,7 @@ search: ## Overview -Griptape exposes a global singleton, [Defaults](../../reference/griptape/configs/defaults.md), which can be used to access and modify the default configurations of the framework. +Griptape exposes a global singleton, [Defaults](../../reference/griptape/configs/defaults_config.md), which can be used to access and modify the default configurations of the framework. To update the default configurations, simply update the fields on the `Defaults` object. Framework objects will be created with the currently set default configurations, but you can always override at the individual class level.