From 4006702123a6ba056d9bcf27820432659284165e Mon Sep 17 00:00:00 2001 From: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com> Date: Wed, 9 Oct 2024 14:04:00 +0200 Subject: [PATCH 1/2] docs: Correct repository information Developer docs have been moved inside the getsentry/sentry-docs repo. Our docs pages should reflect this. --- develop-docs/development/docs/index.mdx | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/develop-docs/development/docs/index.mdx b/develop-docs/development/docs/index.mdx index c0ab81cb9cc10..a9f11c9f0cf58 100644 --- a/develop-docs/development/docs/index.mdx +++ b/develop-docs/development/docs/index.mdx @@ -6,16 +6,11 @@ sidebar_order: 50 Because documentation is a big part of what makes Sentry work we’ve outlined some guidelines about how this documentation is structured and how to extend it. -Sentry's documentation lives in numerous repositories, so what we're covering here is _this site_ and our general approach to documentation. For a guide on contributing to user-facing docs, please see the `getsentry/sentry-docs` [contribution guidelines](https://docs.sentry.io/contributing/). +This page provides a general guidelines for writing both user-facing and developer-facing documentation. We also have more detailed [contribution guidelines](https://docs.sentry.io/contributing/) for writing user-facing documentation. -## Repositories +## Repository -Key places which contain documentation are: - -- [getsentry/sentry-docs](https://github.com/getsentry/sentry-docs) - [docs.sentry.io](https://docs.sentry.io/) -- [getsentry/develop](https://github.com/getsentry/develop) - these docs! - -Our goal is to eventually unify the platform used for docs, which may result in us merging the above repositories. +Sentry's documentation lives in the [getsentry/sentry-docs](https://github.com/getsentry/sentry-docs) repository. ## Stylistic Choices From 8a0ed65c5f6f3d70c6bfb1b561e3ec7691de0ce2 Mon Sep 17 00:00:00 2001 From: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com> Date: Wed, 9 Oct 2024 14:09:35 +0200 Subject: [PATCH 2/2] Update index.mdx --- develop-docs/development/docs/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/develop-docs/development/docs/index.mdx b/develop-docs/development/docs/index.mdx index a9f11c9f0cf58..430d9c4199b2e 100644 --- a/develop-docs/development/docs/index.mdx +++ b/develop-docs/development/docs/index.mdx @@ -6,11 +6,11 @@ sidebar_order: 50 Because documentation is a big part of what makes Sentry work we’ve outlined some guidelines about how this documentation is structured and how to extend it. -This page provides a general guidelines for writing both user-facing and developer-facing documentation. We also have more detailed [contribution guidelines](https://docs.sentry.io/contributing/) for writing user-facing documentation. +This page primarily focuses on writing **developer-facing documentation**, although some concepts may also apply to user-facing documentation. We have separate [contribution guidelines](https://docs.sentry.io/contributing/) specifically for user-facing documenation. ## Repository -Sentry's documentation lives in the [getsentry/sentry-docs](https://github.com/getsentry/sentry-docs) repository. +Sentry's documentation lives in the [getsentry/sentry-docs](https://github.com/getsentry/sentry-docs) repository. The developer documentation is located within the repository's [`develop-docs`](https://github.com/getsentry/sentry-docs/tree/master/develop-docs) directory. ## Stylistic Choices