feat(docs): Improve API documentation in README

michiosw · michiosw · commit e887c5fad23c · 2025-04-15T12:21:39.000-07:00
- Add dedicated API Documentation section to README.md.
- Point directly to Swagger UI (/api/docs) and raw OpenAPI spec (/api/docs/openapi.yaml) endpoints.
- Link to API.md for additional details (Postman import).
- Remove old temp-api-doc.md references implicitly by deleting the file.
diff --git a/API.md b/API.md
@@ -0,0 +1,33 @@
+# Agent Browser API Documentation
+
+## OpenAPI Integration
+
+This API provides OpenAPI 3.1 documentation that can be accessed in various ways:
+
+### Swagger UI
+
+Access the interactive Swagger UI documentation at:
+```
+https://localhost:8080/api/docs
+```
+
+This provides a web-based interface to explore the API, read documentation, and make test requests.
+
+### OpenAPI Specification
+
+The raw OpenAPI specification can be accessed at:
+```
+https://localhost:8080/api/docs/openapi.yaml
+```
+
+### Postman Integration
+
+To use this API with Postman:
+
+1. Open Postman
+2. Click on "Import" in the top left corner
+3. Select the "Link" tab
+4. Enter the URL: `https://localhost:8080/api/docs/openapi.yaml`
+5. Click "Import"
+
+This will create a Postman collection with all endpoints pre-configured.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at michel@cobrowser.xyz. All complaints will be reviewed and investigated promptly and
+fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,99 @@
+# Contributing to Agent Browser
+
+First off, thank you for considering contributing to agent-browser!
+This project is released under the MIT License, which means your contributions
+will also be covered under the same permissive license.
+
+### Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [How to Contribute](#how-to-contribute)
+  - [Guidelines for Non-Code Contributions](#guidelines-for-non-code-contributions)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Pull Requests](#pull-requests)
+- [Development Process](#development-process)
+- [License](#license)
+
+## Code of Conduct
+
+We have adopted a Code of Conduct that we expect project participants to adhere
+to. Please read [the full text](CODE_OF_CONDUCT.md) so that you can understand
+what actions will and will not be tolerated.
+
+## Getting Started
+
+### Fork-based workflow (recommended as a playground)
+
+1. Fork the repository
+2. Clone your fork:
+   `git clone https://github.com/your-username/agent-browser.git`
+3. Create a new branch: `git checkout -b feature/your-feature-name`
+4. Make your changes
+5. Push to your fork: `git push origin feature/your-feature-name`
+6. Open a Pull Request
+
+### Direct repository workflow (for contributors)
+
+1. Clone the repository directly:
+   `git clone https://github.com/co-browser/agent-browser.git`
+2. Create a new branch: `git checkout -b feature/your-feature-name`
+3. Make your changes
+4. Push to the repository: `git push origin feature/your-feature-name`
+5. Open a Pull Request
+
+If you're interested in being contributor, please reach out to the maintainers
+after making a few successful contributions via issues and pull requests.
+
+## How to Contribute
+
+### Guidelines for Non-Code Contributions
+
+We appreciate your attention to detail. However, minor fixes like typos or
+grammar corrections should not be submitted individually. Instead, create an
+issue noting these corrections, and we'll batch them into larger updates.
+
+### Reporting Bugs
+
+We use GitHub issues to track bugs. Before creating a bug report:
+
+- Search existing
+  [Issues](https://github.com/co-browser/agent-browser/issues) to
+  ensure it hasn't already been reported
+- If you find a closed issue that seems to address your problem, open a new
+  issue and include a link to the original
+
+When submitting a bug report, please use our bug report template and include as
+much detail as possible.
+
+### Suggesting Enhancements
+
+Enhancement suggestions are tracked through GitHub issues. Please use our
+feature request template when suggesting enhancements.
+
+### Pull Requests
+
+- Follow our pull request template
+- Include screenshots and animated GIFs in your pull request whenever possible
+- Follow our coding conventions and style guidelines
+- Write meaningful commit messages
+- Update documentation as needed
+- Add tests for new features
+- Pull requests undergo automated checks, including build and linting
+
+## Development Process
+
+1. Pick an issue to work on or create a new one
+2. Comment on the issue to let others know you're working on it
+3. Create a branch with a descriptive name
+4. Write your code following our style guidelines
+5. Add tests for new functionality
+6. Update documentation as needed
+7. Submit a pull request
+8. Respond to code review feedback
+
+## License
+
+By contributing to agent-browser, you agree that your contributions
+will be licensed under the MIT License. See [LICENSE](LICENSE) for details.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 cobrowser.xyz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -69,26 +69,17 @@ This project uses Go modules and follows a standard Go project layout:
 
 2. **Access the UI (Placeholder):** Open your browser to `https://localhost:8080/ui`.
 
-## Development
-
-### Common Makefile Targets
+## API Documentation
 
-* `make setup`: Runs `scripts/setup.sh` to install/update necessary development tools (`templ`, `golangci-lint`) and check `PATH`.
-* `make build`: Compile the application binary into `out/agent-browser`.
-* `make run`: Build and run the application.
-* `make generate`: Generate Go code from `.templ` files.
-* `make test`: Run Go tests.
-* `make fmt`: Format Go code (`gofmt`) and `.templ` files (`templ fmt`).
-* `make tidy`: Tidy `go.mod` and `go.sum` files.
-* `make lint`: Run the Go linter (`golangci-lint`).
-* `make help`: Show all available targets.
+The backend server exposes a REST API for managing resources. When the server is running, you can access the documentation via:
 
-## Continuous Integration
+*   **Interactive Documentation (Swagger UI):** `https://localhost:8080/api/docs`
+*   **Raw OpenAPI Specification:** `https://localhost:8080/api/docs/openapi.yaml`
 
-This project uses GitHub Actions for Continuous Integration (CI) and release automation. The workflows are defined in the `.github/workflows/` directory.
+See [API.md](API.md) for additional details, such as importing the specification into tools like Postman.
 
-*   **Go CI (`go.yaml`):** This workflow runs on pushes and pull requests to the `main` branch. It checks out the code, sets up Go, runs `make setup`, `make tidy`, formatting checks (`make fmt`), linting (`make lint`), tests (`make test`) and builds the project (`make build`) to ensure Go code quality and stability.
+## Development
 
-*   **MegaLinter (`mega-linter.yaml`):** This workflow runs on pushes and pull requests to the `main` branch. It utilizes [MegaLinter](https://megalinter.io/) to analyze the entire codebase using a wide range of linters for various languages and formats (including Go, YAML, Markdown, Shell scripts, etc.). This helps maintain consistent coding standards and identify potential issues across the whole project. Reports are uploaded as artifacts.
+### Common Makefile Targets
 
-*   **Release (`release.yaml`):** This workflow runs only on pushes to the `main` branch. It uses [semantic-release](https://github.com/semantic-release/semantic-release) to automate version management and package publishing. Based on conventional commit messages, it determines the next version number, generates release notes, and creates a Git tag and GitHub release.
+* `
diff --git a/temp-api-doc.md b/temp-api-doc.md
