docs: fix linting in docs (#749)

Fix long lines and table column width lints in docs.

Author: Yuan325

CODE_OF_CONDUCT.md

@@ -14,21 +14,21 @@ race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-*   Using welcoming and inclusive language
-*   Being respectful of differing viewpoints and experiences
-*   Gracefully accepting constructive criticism
-*   Focusing on what is best for the community
-*   Showing empathy towards other community members
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-*   The use of sexualized language or imagery and unwelcome sexual attention or
+* The use of sexualized language or imagery and unwelcome sexual attention or
     advances
-*   Trolling, insulting/derogatory comments, and personal or political attacks
-*   Public or private harassment
-*   Publishing others' private information, such as a physical or electronic
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
     address, without explicit permission
-*   Other conduct which could reasonably be considered inappropriate in a
+* Other conduct which could reasonably be considered inappropriate in a
     professional setting
 
 ## Our Responsibilities
@@ -75,7 +75,7 @@ receive and address reported violations of the code of conduct. They will then
 work with a committee consisting of representatives from the Open Source
 Programs Office and the Google Open Source Strategy team. If for any reason you
 are uncomfortable reaching out to the Project Steward, please email
-[email protected].
+<[email protected]>.
 
 We will investigate every complaint, but you may not receive a direct response.
 We will use our discretion in determining when and how to follow up on reported
@@ -90,4 +90,4 @@ harassment or threats to anyone's safety, we may take action without notice.
 
 This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
 available at
-https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

CONTRIBUTING.md

@@ -32,71 +32,111 @@ use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
 
-Within 2-5 days, a reviewer will review your PR. They may approve it, or request changes. When requesting changes, reviewers should self-assign the PR to ensure they are aware of any updates.
-If additional changes are needed, push additional commits to your PR branch - this helps the reviewer know which parts of the PR have changed. Commits will be squashed when merged.
-Please follow up with changes promptly. If a PR is awaiting changes by the author for more than 10 days, maintainers may mark that PR as Draft. PRs that are inactive for more than 30 days may be closed.
-
+Within 2-5 days, a reviewer will review your PR. They may approve it, or request
+changes. When requesting changes, reviewers should self-assign the PR to ensure
+they are aware of any updates.
+If additional changes are needed, push additional commits to your PR branch -
+this helps the reviewer know which parts of the PR have changed. Commits will be
+squashed when merged.
+Please follow up with changes promptly. If a PR is awaiting changes by the
+author for more than 10 days, maintainers may mark that PR as Draft. PRs that
+are inactive for more than 30 days may be closed.
 
 ### Adding a New Database Source and Tool
 
-We recommend creating an [issue](https://github.com/googleapis/genai-toolbox/issues) before implementation to ensure we can accept the contribution and no duplicated work. If you have any questions, reach out on our [Discord](https://discord.gg/Dmm69peqjh) to chat directly with the team. New contributions should be added with both unit tests and integration tests.
+We recommend creating an
+[issue](https://github.com/googleapis/genai-toolbox/issues) before
+implementation to ensure we can accept the contribution and no duplicated work.
+If you have any questions, reach out on our
+[Discord](https://discord.gg/Dmm69peqjh) to chat directly with the team. New
+contributions should be added with both unit tests and integration tests.
 
 #### 1. Implement the New Data Source
 
-We recommend looking at an [example source implementation](https://github.com/googleapis/genai-toolbox/blob/main/internal/sources/postgres/postgres.go).
-
-*   **Create a new directory** under `internal/sources` for your database type (e.g., `internal/sources/newdb`).
-*   **Define a configuration struct** for your data source in a file named `newdb.go`. Create a `Config` struct to include all the necessary parameters for connecting to the database (e.g., host, port, username, password, database name) and a `Source` struct to store necessary parameters for tools (e.g., Name, Kind, connection object, additional config).
-*   **Implement the [`SourceConfig`](https://github.com/googleapis/genai-toolbox/blob/fd300dc606d88bf9f7bba689e2cee4e3565537dd/internal/sources/sources.go#L57) interface**. This interface requires two methods:
-    *   `SourceConfigKind() string`: Returns a unique string identifier for your data source (e.g., `"newdb"`).
-    *   `Initialize(ctx context.Context, tracer trace.Tracer) (Source, error)`: Creates a new instance of your data source and establishes a connection to the database.
-*   **Implement the [`Source`](https://github.com/googleapis/genai-toolbox/blob/fd300dc606d88bf9f7bba689e2cee4e3565537dd/internal/sources/sources.go#L63) interface**. This interface requires one method:
-    *   `SourceKind() string`: Returns the same string identifier as `SourceConfigKind()`.
-*   **Implement `init()`** to register the new Source.
-*   **Implement Unit Tests** in a file named `newdb_test.go`.
+We recommend looking at an [example source
+implementation](https://github.com/googleapis/genai-toolbox/blob/main/internal/sources/postgres/postgres.go).
+
+* **Create a new directory** under `internal/sources` for your database type
+  (e.g., `internal/sources/newdb`).
+* **Define a configuration struct** for your data source in a file named
+  `newdb.go`. Create a `Config` struct to include all the necessary parameters
+  for connecting to the database (e.g., host, port, username, password, database
+  name) and a `Source` struct to store necessary parameters for tools (e.g.,
+  Name, Kind, connection object, additional config).
+* **Implement the
+  [`SourceConfig`](https://github.com/googleapis/genai-toolbox/blob/fd300dc606d88bf9f7bba689e2cee4e3565537dd/internal/sources/sources.go#L57)
+  interface**. This interface requires two methods:
+  * `SourceConfigKind() string`: Returns a unique string identifier for your
+    data source (e.g., `"newdb"`).
+  * `Initialize(ctx context.Context, tracer trace.Tracer) (Source, error)`:
+    Creates a new instance of your data source and establishes a connection to
+    the database.
+* **Implement the
+  [`Source`](https://github.com/googleapis/genai-toolbox/blob/fd300dc606d88bf9f7bba689e2cee4e3565537dd/internal/sources/sources.go#L63)
+  interface**. This interface requires one method:
+  * `SourceKind() string`: Returns the same string identifier as `SourceConfigKind()`.
+* **Implement `init()`** to register the new Source.
+* **Implement Unit Tests** in a file named `newdb_test.go`.
 
 #### 2. Implement the New Tool
 
-We recommend looking at an [example tool implementation](https://github.com/googleapis/genai-toolbox/tree/main/internal/tools/postgressql).
-
-*   **Create a new directory** under `internal/tools` for your tool type (e.g., `internal/tools/newdb` or `internal/tools/newdb<tool_name>`).
-*   **Define a configuration struct** for your tool in a file named `newdbtool.go`.
-Create a `Config` struct and a `Tool` struct to store necessary parameters for tools.
-*   **Implement the [`ToolConfig`](https://github.com/googleapis/genai-toolbox/blob/fd300dc606d88bf9f7bba689e2cee4e3565537dd/internal/tools/tools.go#L61) interface**. This interface requires one method:
-    *   `ToolConfigKind() string`: Returns a unique string identifier for your tool (e.g., `"newdb"`).
-    *   `Initialize(sources map[string]Source) (Tool, error)`: Creates a new instance of your tool and validates that it can connect to the specified data source.
-*   **Implement the `Tool` interface**. This interface requires the following methods:
-    *   `Invoke(ctx context.Context, params map[string]any) ([]any, error)`: Executes the operation on the database using the provided parameters.
-    *   `ParseParams(data map[string]any, claims map[string]map[string]any) (ParamValues, error)`: Parses and validates the input parameters.
-    *   `Manifest() Manifest`: Returns a manifest describing the tool's capabilities and parameters.
-    *   `McpManifest() McpManifest`: Returns an MCP manifest describing the tool for use with the Model Context Protocol.
-    *   `Authorized(services []string) bool`: Checks if the tool is authorized to run based on the provided authentication services.
-*   **Implement `init()`** to register the new Tool.
-*   **Implement Unit Tests** in a file named `newdb_test.go`.
+We recommend looking at an [example tool
+implementation](https://github.com/googleapis/genai-toolbox/tree/main/internal/tools/postgressql).
+
+* **Create a new directory** under `internal/tools` for your tool type (e.g.,
+  `internal/tools/newdb` or `internal/tools/newdb<tool_name>`).
+* **Define a configuration struct** for your tool in a file named `newdbtool.go`.
+Create a `Config` struct and a `Tool` struct to store necessary parameters for
+tools.
+* **Implement the
+  [`ToolConfig`](https://github.com/googleapis/genai-toolbox/blob/fd300dc606d88bf9f7bba689e2cee4e3565537dd/internal/tools/tools.go#L61)
+  interface**. This interface requires one method:
+  * `ToolConfigKind() string`: Returns a unique string identifier for your tool
+    (e.g., `"newdb"`).
+  * `Initialize(sources map[string]Source) (Tool, error)`: Creates a new
+    instance of your tool and validates that it can connect to the specified
+    data source.
+* **Implement the `Tool` interface**. This interface requires the following
+  methods:
+  * `Invoke(ctx context.Context, params map[string]any) ([]any, error)`:
+    Executes the operation on the database using the provided parameters.
+  * `ParseParams(data map[string]any, claims map[string]map[string]any)
+    (ParamValues, error)`: Parses and validates the input parameters.
+  * `Manifest() Manifest`: Returns a manifest describing the tool's capabilities
+    and parameters.
+  * `McpManifest() McpManifest`: Returns an MCP manifest describing the tool for
+    use with the Model Context Protocol.
+  * `Authorized(services []string) bool`: Checks if the tool is authorized to
+    run based on the provided authentication services.
+* **Implement `init()`** to register the new Tool.
+* **Implement Unit Tests** in a file named `newdb_test.go`.
 
 #### 3. Add Integration Tests
 
-*   **Add a test file** under a new directory `tests/newdb`.
-*   **Add pre-defined integration test suites** in the `/tests/newdb/newdb_test.go` that are **required** to be run as long as your code contains related
-features:
+* **Add a test file** under a new directory `tests/newdb`.
+* **Add pre-defined integration test suites** in the
+  `/tests/newdb/newdb_test.go` that are **required** to be run as long as your
+  code contains related features:
 
      1. [RunToolGetTest][tool-get]: tests for the `GET` endpoint that returns the
             tool's manifest.
-     
+
      2. [RunToolInvokeTest][tool-call]: tests for tool calling through the native
         Toolbox endpoints.
-   
+
      3. [RunMCPToolCallMethod][mcp-call]: tests tool calling through the MCP
             endpoints.
-     
+
      4. (Optional) [RunExecuteSqlToolInvokeTest][execute-sql]: tests an
         `execute-sql` tool for any source. Only run this test if you are adding an
         `execute-sql` tool.
-   
+
      5. (Optional) [RunToolInvokeWithTemplateParameters][temp-param]: tests for [template
-            parameters][temp-param-doc]. Only run this test if template parameters apply to your tool.
+            parameters][temp-param-doc]. Only run this test if template
+            parameters apply to your tool.
 
-*   **Add the new database to the test config** in [integration.cloudbuild.yaml](.ci/integration.cloudbuild.yaml).
+* **Add the new database to the test config** in
+  [integration.cloudbuild.yaml](.ci/integration.cloudbuild.yaml).
 
 [tool-get]:
     https://github.com/googleapis/genai-toolbox/blob/fd300dc606d88bf9f7bba689e2cee4e3565537dd/tests/tool.go#L31
@@ -113,20 +153,30 @@ features:
 
 #### 4. Add Documentation
 
-*   **Update the documentation** to include information about your new data source and tool. This includes:
-    *   Adding a new page to the `docs/en/resources/sources` directory for your data source.
-    *   Adding a new page to the `docs/en/resources/tools` directory for your tool.
+* **Update the documentation** to include information about your new data source
+  and tool. This includes:
+  * Adding a new page to the `docs/en/resources/sources` directory for your data
+    source.
+  * Adding a new page to the `docs/en/resources/tools` directory for your tool.
 
-*   **(Optional) Add samples** to the `docs/en/samples/<newdb>` directory.
+* **(Optional) Add samples** to the `docs/en/samples/<newdb>` directory.
 
 #### (Optional) 5. Add Prebuilt Tools
 
-You can provide developers with a set of "build-time" tools to aid common software development user journeys like viewing and creating tables/collections and data.
+You can provide developers with a set of "build-time" tools to aid common
+software development user journeys like viewing and creating tables/collections
+and data.
 
-*   **Create a set of prebuilt tools** by defining a new `tools.yaml` and adding it to `internal/tools`. Make sure the file name matches the source (i.e. for source "alloydb-postgres" create a file named "alloydb-postgres.yaml").
-*   **Update `cmd/root.go`** to add new source to the `prebuilt` flag.
-*   **Add tests** in [internal/prebuiltconfigs/prebuiltconfigs_test.go](internal/prebuiltconfigs/prebuiltconfigs_test.go) and [cmd/root_test.go](cmd/root_test.go).
+* **Create a set of prebuilt tools** by defining a new `tools.yaml` and adding
+  it to `internal/tools`. Make sure the file name matches the source (i.e. for
+  source "alloydb-postgres" create a file named "alloydb-postgres.yaml").
+* **Update `cmd/root.go`** to add new source to the `prebuilt` flag.
+* **Add tests** in
+  [internal/prebuiltconfigs/prebuiltconfigs_test.go](internal/prebuiltconfigs/prebuiltconfigs_test.go)
+  and [cmd/root_test.go](cmd/root_test.go).
 
 #### 6. Submit a Pull Request
 
-*   **Submit a pull request** to the repository with your changes. Be sure to include a detailed description of your changes and any requests for long term testing resources.
+* **Submit a pull request** to the repository with your changes. Be sure to
+  include a detailed description of your changes and any requests for long term
+  testing resources.