Skip to content

docs: reorganize the About section #18236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jun 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ Read [cursor rules](.cursorrules).

## Frontend

For building Frontend refer to [this document](docs/contributing/frontend.md)
For building Frontend refer to [this document](docs/about/contributing/frontend.md)
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!-- markdownlint-disable MD041 -->
[https://coder.com/docs/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT)
[https://coder.com/docs/about/contributing/CODE_OF_CONDUCT](https://coder.com/docs/about/contributing/CODE_OF_CONDUCT)
2 changes: 1 addition & 1 deletion coderd/database/migrations/migrate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ func TestMigrateUpWithFixtures(t *testing.T) {
if len(emptyTables) > 0 {
t.Log("The following tables have zero rows, consider adding fixtures for them or create a full database dump:")
t.Errorf("tables have zero rows: %v", emptyTables)
t.Log("See https://github.com/coder/coder/blob/main/docs/CONTRIBUTING.md#database-fixtures-for-testing-migrations for more information")
t.Log("See https://github.com/coder/coder/blob/main/docs/about/contributing/backend.md#database-fixtures-for-testing-migrations for more information")
}
})

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,9 @@ channel.

## Styling

Visit our [documentation style guide](./contributing/documentation.md).
- [Documentation style guide](./documentation.md)

Frontend styling guide can be found [here](./contributing/frontend.md#styling).
- [Frontend styling guide](./frontend.md#styling)

## Reviews

Expand Down
11 changes: 11 additions & 0 deletions docs/about/contributing/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Security Policy

Coder welcomes feedback from security researchers and the general public to help improve our security.
If you believe you have discovered a vulnerability, privacy issue, exposed data, or other security issues
in any of our assets, we want to hear from you.

If you find a vulnerability, **DO NOT FILE AN ISSUE**.
Instead, send an email to
<[email protected]>.

Refer to the [Security policy](https://coder.com/security/policy) for more information.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ new conventions, but all new components should follow these guidelines.

## Styling

We use [Emotion](https://emotion.sh/) to handle css styles.
We use [Emotion](https://emotion.sh/) to handle CSS styles.

## Forms

Expand Down
File renamed without changes.
File renamed without changes.
3 changes: 1 addition & 2 deletions docs/admin/security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ For other security tips, visit our guide to

> [!CAUTION]
> If you discover a vulnerability in Coder, please do not hesitate to report it
> to us by following the instructions
> [here](https://github.com/coder/coder/blob/main/SECURITY.md).
> to us by following the [security policy](https://github.com/coder/coder/blob/main/SECURITY.md).
From time to time, Coder employees or other community members may discover
vulnerabilities in the product.
Expand Down
8 changes: 4 additions & 4 deletions docs/admin/templates/extending-templates/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ For a full list of available modules please check

## Offline installations

In offline and restricted deploymnets, there are 2 ways to fetch modules.
In offline and restricted deployments, there are two ways to fetch modules.

1. Artifactory
2. Private git repository

### Artifactory

Air gapped users can clone the [coder/modules](https://github.com/coder/modules)
Air gapped users can clone the [coder/registry](https://github.com/coder/registry/)
repo and publish a
[local terraform module repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/set-up-a-terraform-module/provider-registry)
to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
Expand All @@ -71,8 +71,8 @@ to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
3. Follow the below instructions to publish coder modules to Artifactory

```shell
git clone https://github.com/coder/modules
cd modules
git clone https://github.com/coder/registry
cd registry/coder/modules
jf tfc
jf tf p --namespace="coder" --provider="coder" --tag="1.0.0"
```
Expand Down
4 changes: 2 additions & 2 deletions docs/ai-coder/custom-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ any-custom-agent configure-mcp --name "coder" --command "coder exp mcp server"

This will start the MCP server and report activity back to the Coder control plane on behalf of the coder_app resource.

> See the [Goose module](https://github.com/coder/modules/blob/main/goose/main.tf) source code for a real world example.
> See the [Goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf) source code for a real world example.
## Contributing

We welcome contributions for various agents via the [Coder registry](https://registry.coder.com/modules?tag=agent)!

See our [contributing guide](https://github.com/coder/modules/blob/main/CONTRIBUTING.md) for more information.
See our [contributing guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md) for more information.
4 changes: 0 additions & 4 deletions docs/contributing/SECURITY.md

This file was deleted.

99 changes: 53 additions & 46 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,65 @@
"path": "./README.md",
"icon_path": "./images/icons/home.svg",
"children": [
{
"title": "Screenshots",
"description": "View screenshots of the Coder platform",
"path": "./about/screenshots.md"
},
{
"title": "Quickstart",
"description": "Learn how to install and run Coder quickly",
"path": "./tutorials/quickstart.md"
},
{
"title": "Screenshots",
"description": "View screenshots of the Coder platform",
"path": "./start/screenshots.md"
"title": "Support",
"description": "How Coder supports your deployment and you",
"path": "./support/index.md",
"children": [
{
"title": "Generate a Support Bundle",
"description": "Generate and upload a Support Bundle to Coder Support",
"path": "./support/support-bundle.md"
}
]
},
{
"title": "Contributing",
"description": "Learn how to contribute to Coder",
"path": "./about/contributing/CONTRIBUTING.md",
"icon_path": "./images/icons/contributing.svg",
"children": [
{
"title": "Code of Conduct",
"description": "See the code of conduct for contributing to Coder",
"path": "./about/contributing/CODE_OF_CONDUCT.md",
"icon_path": "./images/icons/circle-dot.svg"
},
{
"title": "Documentation",
"description": "Our style guide for use when authoring documentation",
"path": "./about/contributing/documentation.md",
"icon_path": "./images/icons/document.svg"
},
{
"title": "Backend",
"description": "Our guide for backend development",
"path": "./about/contributing/backend.md",
"icon_path": "./images/icons/gear.svg"
},
{
"title": "Frontend",
"description": "Our guide for frontend development",
"path": "./about/contributing/frontend.md",
"icon_path": "./images/icons/frontend.svg"
},
{
"title": "Security",
"description": "Security vulnerability disclosure policy",
"path": "./about/contributing/SECURITY.md",
"icon_path": "./images/icons/lock.svg"
}
]
}
]
},
Expand Down Expand Up @@ -810,44 +860,6 @@
}
]
},
{
"title": "Contributing",
"description": "Learn how to contribute to Coder",
"path": "./CONTRIBUTING.md",
"icon_path": "./images/icons/contributing.svg",
"children": [
{
"title": "Code of Conduct",
"description": "See the code of conduct for contributing to Coder",
"path": "./contributing/CODE_OF_CONDUCT.md",
"icon_path": "./images/icons/circle-dot.svg"
},
{
"title": "Documentation",
"description": "Our style guide for use when authoring documentation",
"path": "./contributing/documentation.md",
"icon_path": "./images/icons/document.svg"
},
{
"title": "Backend",
"description": "Our guide for backend development",
"path": "./contributing/backend.md",
"icon_path": "./images/icons/gear.svg"
},
{
"title": "Frontend",
"description": "Our guide for frontend development",
"path": "./contributing/frontend.md",
"icon_path": "./images/icons/frontend.svg"
},
{
"title": "Security",
"description": "Our guide for security",
"path": "./contributing/SECURITY.md",
"icon_path": "./images/icons/lock.svg"
}
]
},
{
"title": "Tutorials",
"description": "Coder knowledgebase for administrating your deployment",
Expand All @@ -874,11 +886,6 @@
"description": "Learn about image management with Coder",
"path": "./admin/templates/managing-templates/image-management.md"
},
{
"title": "Generate a Support Bundle",
"description": "Generate and upload a Support Bundle to Coder Support",
"path": "./tutorials/support-bundle.md"
},
{
"title": "Configuring Okta",
"description": "Custom claims/scopes with Okta for group/role sync",
Expand Down
5 changes: 5 additions & 0 deletions docs/support/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Support

If you have questions, encounter an issue or bug, or if you have a feature request, [open a GitHub issue](https://github.com/coder/coder/issues/new) or [join our Discord](https://discord.gg/coder).

<children></children>
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/user-guides/workspace-access/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Supported IDEs:
Our [Module Registry](https://registry.coder.com/modules) also hosts a variety
of tools for extending the capability of your workspace. If you have a request
for a new IDE or tool, please file an issue in our
[Modules repo](https://github.com/coder/modules/issues).
[Modules repo](https://github.com/coder/registry/issues).

## Ports and Port forwarding

Expand Down
Loading