update:doc

Author: yumafuu

docs/index.md

@@ -1,55 +1,44 @@
-# KW GitHub Provider
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "kwgithub Provider"
+description: |-
+  The KW GitHub provider is used to interact with GitHub resources specific to Knowledge Work organization.
+---
 
-The KW GitHub provider is used to interact with GitHub resources specific to Knowledge Work organization.
-
-## Authentication
+# kwgithub Provider
 
-The provider supports two authentication methods:
+The KW GitHub provider is used to interact with GitHub resources specific to Knowledge Work organization.
 
-### Personal Access Token
+## Example Usage
 
 ```terraform
 provider "kwgithub" {
   token = var.github_token
   owner = "knowledge-work"
 }
-```
 
-### GitHub App Installation
-
-```terraform
+# GitHub App authentication example
 provider "kwgithub" {
   owner = "knowledge-work"
   app_auth {}
 }
 ```
 
-## Configuration
-
-### Arguments
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-* `token` - (Optional) GitHub personal access token. Can also be set via `GITHUB_TOKEN` environment variable.
-* `owner` - (Optional) GitHub owner name to manage. Can also be set via `GITHUB_OWNER` environment variable.
-* `github_base_url` - (Optional) GitHub base URL. Defaults to https://api.github.com. Can also be set via `GITHUB_BASE_URL` environment variable.
-* `app_auth` - (Optional) Configuration block to use GitHub App installation token. Conflicts with `token`.
-  * `id` - (Optional) GitHub App ID. Can also be set via `GITHUB_APP_ID` environment variable.
-  * `installation_id` - (Optional) GitHub App installation ID. Can also be set via `GITHUB_APP_INSTALLATION_ID` environment variable.
-  * `pem_file` - (Optional) GitHub App private key PEM file contents. Can also be set via `GITHUB_APP_PEM_FILE` environment variable.
+### Optional
 
-### Environment Variables
+- `app_auth` (Block List) GitHub App authentication configuration. Conflicts with token. (see [below for nested schema](#nestedblock--app_auth))
+- `github_base_url` (String) GitHub base URL. Defaults to https://api.github.com. Can also be set via GITHUB_BASE_URL environment variable.
+- `owner` (String) GitHub owner name to manage. Can also be set via GITHUB_OWNER environment variable.
+- `token` (String, Sensitive) GitHub personal access token. Can also be set via GITHUB_TOKEN environment variable.
 
-When using environment variables, an empty `app_auth` block is required to allow provider configurations from environment variables to be specified:
-
-```terraform
-provider "kwgithub" {
-  owner = "knowledge-work"
-  app_auth {}
-}
-```
+<a id="nestedblock--app_auth"></a>
+### Nested Schema for `app_auth`
 
-Set the following environment variables:
-- `GITHUB_APP_ID`
-- `GITHUB_APP_INSTALLATION_ID`
-- `GITHUB_APP_PEM_FILE`
+Optional:
 
-Note: If you have a PEM file on disk, you can pass it in via `pem_file = file("path/to/file.pem")`.
+- `id` (String) GitHub App ID. Can also be set via GITHUB_APP_ID environment variable.
+- `installation_id` (String) GitHub App installation ID. Can also be set via GITHUB_APP_INSTALLATION_ID environment variable.
+- `pem_file` (String, Sensitive) GitHub App private key PEM file contents. Can also be set via GITHUB_APP_PEM_FILE environment variable.

docs/resources/ruleset_allowed_merge_methods.md

@@ -26,7 +26,7 @@ resource "kwgithub_ruleset_allowed_merge_methods" "example" {
 ### Required
 
 - `allowed_merge_methods` (Set of String) Set of allowed merge methods. Valid values are: 'merge', 'squash', 'rebase'.
-- `repository` (String) The name of the repository (e.g., 'owner/repo').
+- `repository` (String) The name of the repository (e.g., 'repo-name').
 - `ruleset_id` (String) The ID of the ruleset to manage.
 
 ### Optional