Skip to content

Commit

Permalink
Fix reference link. Add Makefile docs serve command
Browse files Browse the repository at this point in the history
  • Loading branch information
zachgiordano committed Sep 9, 2024
1 parent ad0c28b commit 1bc1a5f
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/griptape-framework/structures/configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 1bc1a5f

Please sign in to comment.