agent-docs 1.0.0

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+## Which library or Salesforce API is missing?
+
+## Is there an official page?
+
+## Are there other useful pages?
+
+## Is there a public source code repository?
+
+## Is this related to any other files already in docs?

package/.github/dependabot.yml

@@ -0,0 +1,38 @@
+version: 2
+updates:
+    # Update npm/pnpm dependencies (package.json and pnpm-lock.yaml)
+    - package-ecosystem: 'npm'
+      directory: '/'
+      schedule:
+          interval: 'daily'
+      open-pull-requests-limit: 10
+      labels:
+          - 'dependencies'
+          - 'npm'
+      commit-message:
+          prefix: 'chore'
+          include: 'scope'
+      groups:
+          dev-dependencies:
+              patterns:
+                  - '*'
+              update-types:
+                  - 'minor'
+                  - 'patch'
+
+    # Update GitHub Actions workflows
+    - package-ecosystem: 'github-actions'
+      directory: '/'
+      schedule:
+          interval: 'daily'
+      open-pull-requests-limit: 10
+      labels:
+          - 'dependencies'
+          - 'github-actions'
+      commit-message:
+          prefix: 'chore'
+          include: 'scope'
+      groups:
+          github-actions:
+              patterns:
+                  - '*'

package/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+## Description
+
+<!-- Provide a brief description of your changes -->
+
+## Type of Change
+
+- [ ] New document(s)
+- [ ] Update document(s)
+- [ ] New script(s)
+- [ ] Update script(s)

package/.github/workflows/format.yml

@@ -0,0 +1,35 @@
+name: Format
+permissions:
+    contents: read
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    format:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [24]
+
+        steps:
+            - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+
+            - name: Install pnpm
+              uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4
+
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6
+              with:
+                  node-version: ${{ matrix.node-version }}
+                  cache: 'pnpm'
+
+            - name: Install dependencies
+              run: pnpm install --frozen-lockfile
+
+            - name: Check formatting
+              run: pnpm format:check

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,64 @@
+# 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, 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.
+
+## Scope
+
+This Code of Conduct applies within all community spaces and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+security@starch.uk. All complaints will be reviewed and investigated promptly
+and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+
+[homepage]: https://www.contributor-covenant.org

package/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing to agent-docs
+
+Thank you for considering contributing to agent-docs! We welcome contributions
+from the community.
+
+## How to Contribute
+
+1. **Fork the repository** and clone it to your local machine
+2. **Create a new branch** for your feature or bug fix:
+    ```bash
+    git checkout -b feature/your-feature-name
+    ```
+3. **Make your changes** following the project's code style and conventions
+4. **Run tests** to ensure everything passes:
+    ```bash
+    pnpm test
+    ```
+5. **Format your code**:
+    ```bash
+    pnpm format
+    ```
+6. **Commit your changes** with a descriptive commit message:
+    ```bash
+    git commit -m "Add feature: your feature description"
+    ```
+7. **Push your changes** to your forked repository:
+    ```bash
+    git push origin feature/your-feature-name
+    ```
+8. **Open a pull request** to the main repository's `main` branch
+
+## Code Style
+
+- Follow TypeScript strict mode conventions
+- Use Prettier for formatting (run `pnpm format` before committing)
+- Write comprehensive tests for new features
+- Ensure all tests pass before submitting a PR
+
+## Reporting Issues
+
+If you encounter any issues or have suggestions for improvements, please open an
+issue in the repository with:
+
+- A clear description of the issue
+- Steps to reproduce (if applicable)
+- Expected vs actual behavior
+- Environment details (OS, Node version, etc.)
+
+## License
+
+By contributing to agent-docs, you agree that your contributions will be
+licensed under the MIT License.

package/LICENSE.md

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 starch-uk
+
+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.