From fbae680e06566b3672ced937ef8e5241e50a16a4 Mon Sep 17 00:00:00 2001 From: Kevin Strider Date: Thu, 24 Nov 2022 09:54:37 -0800 Subject: [PATCH] Under the Hood - Part 1 Summary: This diff includes minor changes to the pages within the Under the Hood section of Flipper Docs. Reviewed By: passy Differential Revision: D41521538 fbshipit-source-id: 35b372ffdde118faef2732e4cb7684fc9df18f87 --- docs/internals/contributing.mdx | 2 +- docs/internals/index.mdx | 22 +++++++++++++++++++++- docs/internals/linters.mdx | 2 +- website/sidebars.js | 8 ++++---- 4 files changed, 27 insertions(+), 7 deletions(-) diff --git a/docs/internals/contributing.mdx b/docs/internals/contributing.mdx index 8177c798f..0e9221b79 100644 --- a/docs/internals/contributing.mdx +++ b/docs/internals/contributing.mdx @@ -4,7 +4,7 @@ title: Contributing to the Codebase --- import useBaseUrl from '@docusaurus/useBaseUrl'; -This page contains information that helps you make contributions to the Flipper codebase. +This page contains information that will help you make contributions to the Flipper codebase. ## Changelog Entries diff --git a/docs/internals/index.mdx b/docs/internals/index.mdx index c270b1f3c..b17561bd1 100644 --- a/docs/internals/index.mdx +++ b/docs/internals/index.mdx @@ -6,4 +6,24 @@ sidebar_label: Introduction This part of the site is for those interested in **how** Flipper works 'under the hood'. -The information contained within this section's pages help Developers modify the source code of the application itself. +'Under the Hood' contains the following topics: + +* [Contributing to the Codebase](contributing.mdx) - contains information that helps you make contributions to the Flipper codebase. +* [Contributing to the Documentation](documentation-writing-guide.mdx) - contains tips and guidelines on how to create effective documentation that will be valued by your target reader. +* [Device Identifiers](device-identifiers.mdx) - details availabe methods for obtaining device identifiers. +* [Linters](linters.mdx) - a list of Linters that are used to enforce sustainable coding practices within Flipper. +* [Public Flipper Releases](../extending/public-releases.mdx) - the mechanism behind Flipper releases on GitHub. +* [Testing React Native Changes](../extending/testing-rn.mdx) - how to use the 'ReactNativeFlippeExample' app to test React Native changes. + + + +In addition, the section contains a wide range of internal-only (see 'Under the Hood -> 'Internal') topics, such as: + +* [Data Pipelines](../fb/data-pipelines.mdx) - information on Deep Dive, Flipper Analytics, Scribe, Error Logging, plus a series of links relating to architecture, Static Docs, and code Pointers. +* [Launcher](../fb/hackin-on-launcher.mdx) - details of hacking on Launcher and the LauncherConfig. +* [Releases](../fb/Flipper-Release-Cycle.mdx) - information on the Flipper release cycle, the release infrastructure @ Meta, and Flipper fbsource pinning. +* [Sandcastle](../fb/sandcastle-overview.mdx) - provides an overview of Continuous Intergration-related topics, including: basic terminology, frameworks, commands, and how to overcome specific issues. +* [Support](../fb/Oncall-Runbook.mdx) - details of alerts, adding a Support group, and the Oncall Runbook. +* **Much more** - have a look at the what's available by exploring the 'Under the Hood' section of the NavBar. + + diff --git a/docs/internals/linters.mdx b/docs/internals/linters.mdx index ce0e9b401..1df2c92c1 100644 --- a/docs/internals/linters.mdx +++ b/docs/internals/linters.mdx @@ -4,7 +4,7 @@ title: Linters sidebar_label: Linters --- -Flipper Desktop comes with a variety of ESLint checks pre-enabled. This enables us to enforce sustainable coding practices and skip over discussions in code reviews. +Flipper Desktop comes with a variety of ESLint checks pre-enabled, which enable us to enforce sustainable coding practices and skip over discussions in code reviews. ## Specific Linters diff --git a/website/sidebars.js b/website/sidebars.js index 11328949e..8a32102d3 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -147,16 +147,16 @@ module.exports = { 'Under the Hood': [ 'internals/index', 'internals/contributing', - { - 'Contributing to the Documentation': ['internals/documentation-formatting', 'internals/documentation-writing-guide'], - }, 'internals/device-identifiers', 'internals/linters', 'extending/public-releases', 'extending/testing-rn', ...fbInternalOnly([ { - "Meta": [ + 'Internal': [ + { + 'Contributing to the Documentation': ['internals/documentation-formatting', 'internals/documentation-writing-guide'], + }, 'fb/arc_uiqr', 'fb/connections', {