Skip to content

Commit f1cca03

Browse files
EdwardAngertEdwardAngert
authored
docs: reorganize the About section (#18236)
As part of an information architecture overhaul, this PR reorganizes the About section and adds a Support section (but not content to it yet) [preview](https://coder.com/docs/@docs-ia-about/about) this PR is intentionally limited in scope so that we can ship meaningful changes faster and followup PRs should include: - [ ] edit + overhaul the About page - [ ] decide on the `start` directory - [ ] ~screenshots page updates~ (this should happen July or later) redirects PR: https://github.com/coder/coder.com/pull/944 --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent 5944b1c commit f1cca03

File tree

19 files changed

+83
-65
lines changed

19 files changed

+83
-65
lines changed

‎CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ Read [cursor rules](.cursorrules).
101101

102102
## Frontend
103103

104-
For building Frontend refer to [this document](docs/contributing/frontend.md)
104+
For building Frontend refer to [this document](docs/about/contributing/frontend.md)

‎CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
<!-- markdownlint-disable MD041 -->
2-
[https://coder.com/docs/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT)
2+
[https://coder.com/docs/about/contributing/CODE_OF_CONDUCT](https://coder.com/docs/about/contributing/CODE_OF_CONDUCT)

‎coderd/database/migrations/migrate_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ func TestMigrateUpWithFixtures(t *testing.T) {
283283
if len(emptyTables) > 0 {
284284
t.Log("The following tables have zero rows, consider adding fixtures for them or create a full database dump:")
285285
t.Errorf("tables have zero rows: %v", emptyTables)
286-
t.Log("See https://github.com/coder/coder/blob/main/docs/CONTRIBUTING.md#database-fixtures-for-testing-migrations for more information")
286+
t.Log("See https://github.com/coder/coder/blob/main/docs/about/contributing/backend.md#database-fixtures-for-testing-migrations for more information")
287287
}
288288
})
289289

‎docs/contributing/CODE_OF_CONDUCT.md renamed to ‎docs/about/contributing/CODE_OF_CONDUCT.md

File renamed without changes.

‎docs/CONTRIBUTING.md renamed to ‎docs/about/contributing/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,9 @@ channel.
143143

144144
## Styling
145145

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

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

150150
## Reviews
151151

‎docs/about/contributing/SECURITY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
Coder welcomes feedback from security researchers and the general public to help improve our security.
4+
If you believe you have discovered a vulnerability, privacy issue, exposed data, or other security issues
5+
in any of our assets, we want to hear from you.
6+
7+
If you find a vulnerability, **DO NOT FILE AN ISSUE**.
8+
Instead, send an email to
9+
<security@coder.com>.
10+
11+
Refer to the [Security policy](https://coder.com/security/policy) for more information.

‎docs/contributing/backend.md renamed to ‎docs/about/contributing/backend.md

File renamed without changes.

‎docs/contributing/documentation.md renamed to ‎docs/about/contributing/documentation.md

File renamed without changes.

‎docs/contributing/frontend.md renamed to ‎docs/about/contributing/frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ new conventions, but all new components should follow these guidelines.
250250

251251
## Styling
252252

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

255255
## Forms
256256

‎docs/start/screenshots.md renamed to ‎docs/about/screenshots.md

File renamed without changes.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy