Skip to content

Commit

Permalink
doc: fix typo, format note
Browse files Browse the repository at this point in the history
  • Loading branch information
jar-b authored Jan 3, 2025
1 parent 2c3d3a1 commit fe5258d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Once the schema is loaded two search modes are available.

- `Schema` mode expects an exact resource or data source name as the search term, and
will render the resulting schema documentation to the viewport. Example search terms
are be [`random_string`](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string)
are [`random_string`](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string)
or [`aws_instance`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance).

- `Resource` mode accepts any search term, and will list all resources or data sources
Expand All @@ -63,6 +63,7 @@ adopting a new, unfamiliar provider. `provdoc` utilizes the existing
documentation available from provider schemas to supply searchable documentation
directly in the terminal.

> [!NOTE]
> Documentation is parsed and rendered from the provider schema, so the utility
> of what is displayed is largely dependent on what the provider developer includes
> there. Some providers (for example the AWS Terraform Provider)
Expand Down

0 comments on commit fe5258d

Please sign in to comment.