0a8577e948
Summary: Kevin Strider after reviewing Flipper docs structure suggested to show all sections in sidebar. This will make it easier for users to navigate website as they will be able to find all the content through sidebar menu. Before that only current section items were shown, so e.g. if user clicks "Learn more" on the start page they open "Features" section and it's not clear that there are a lot of other content (Setup, Creating Plugins, Under the Hood) which is only available through the top menu. Reviewed By: antonk52 Differential Revision: D36762008 fbshipit-source-id: a36cfb77e5d2efd4f5d8795d1c68e46d07ed79e1
178 lines
4.7 KiB
JavaScript
178 lines
4.7 KiB
JavaScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
const {fbInternalOnly, fbContent} = require('internaldocs-fb-helpers');
|
|
|
|
module.exports = {
|
|
main: {
|
|
Features: [
|
|
'features/index',
|
|
'features/share-flipper-data',
|
|
'features/react-native',
|
|
{
|
|
Plugins: [
|
|
{
|
|
type: 'autogenerated',
|
|
dirName: 'features/plugins',
|
|
},
|
|
],
|
|
},
|
|
...fbInternalOnly(['fb/plugins']),
|
|
],
|
|
Setup: [
|
|
'getting-started/index',
|
|
{
|
|
'Adding Flipper to your app': [
|
|
...fbContent({
|
|
external: [
|
|
'getting-started/android-native',
|
|
'getting-started/ios-native',
|
|
],
|
|
internal: [
|
|
{
|
|
Android: [
|
|
'fb/Add-flipper-to-android-app',
|
|
'getting-started/android-native',
|
|
],
|
|
iOS: [
|
|
'fb/Adding-flipper-to-ios-app',
|
|
'getting-started/ios-native',
|
|
],
|
|
},
|
|
],
|
|
}),
|
|
{
|
|
'React Native': [
|
|
'getting-started/react-native',
|
|
'getting-started/react-native-android',
|
|
'getting-started/react-native-ios',
|
|
],
|
|
},
|
|
'getting-started/javascript',
|
|
],
|
|
},
|
|
...fbInternalOnly(['getting-started/fb/connecting-to-flipper']),
|
|
...fbInternalOnly(['getting-started/fb/flipper-on-demand']),
|
|
{
|
|
Troubleshooting: [
|
|
'getting-started/troubleshooting/troubleshooting',
|
|
'getting-started/troubleshooting/general',
|
|
'getting-started/troubleshooting/android',
|
|
'getting-started/troubleshooting/ios',
|
|
'getting-started/troubleshooting/react-native',
|
|
],
|
|
},
|
|
{
|
|
'Other Platforms': [
|
|
'extending/new-clients',
|
|
'extending/establishing-a-connection',
|
|
'extending/supporting-layout',
|
|
],
|
|
},
|
|
{
|
|
'Plugin Setup': [
|
|
{
|
|
type: 'autogenerated',
|
|
dirName: 'setup/plugins',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
Advanced: [
|
|
'custom-ports',
|
|
'stetho',
|
|
...fbInternalOnly(['fb/www-certificate-exchange']),
|
|
],
|
|
},
|
|
],
|
|
'Creating Plugins': [
|
|
'tutorial/intro',
|
|
'tutorial/ios',
|
|
'tutorial/android',
|
|
'tutorial/react-native',
|
|
'tutorial/javascript',
|
|
{
|
|
'Building a Desktop Plugin': [
|
|
'tutorial/js-setup',
|
|
'tutorial/js-table',
|
|
'tutorial/js-custom',
|
|
],
|
|
},
|
|
'tutorial/js-publishing',
|
|
{
|
|
'Development Workflow': [
|
|
'extending/dev-setup',
|
|
'extending/loading-custom-plugins',
|
|
'extending/desktop-plugin-structure',
|
|
'extending/testing',
|
|
'extending/debugging',
|
|
...fbInternalOnly([
|
|
'fb/adding-analytics-0',
|
|
'extending/fb/plugin-documentation',
|
|
]),
|
|
'extending/plugin-distribution',
|
|
'extending/sandy-migration',
|
|
],
|
|
},
|
|
{
|
|
'Desktop Plugin APIs': [
|
|
'extending/flipper-plugin',
|
|
'extending/styling-components',
|
|
'extending/style-guide',
|
|
'extending/deeplinks',
|
|
'extending/node-apis',
|
|
...fbInternalOnly([
|
|
{
|
|
'QPL linting': ['fb/building-a-linter', 'fb/active-linters'],
|
|
},
|
|
]),
|
|
],
|
|
},
|
|
{
|
|
'Client Plugin APIs': [
|
|
'extending/create-plugin',
|
|
'extending/error-handling',
|
|
'extending/arch',
|
|
'extending/client-plugin-lifecycle',
|
|
'extending/layout-inspector',
|
|
],
|
|
},
|
|
],
|
|
'Under the Hood': [
|
|
'internals/index',
|
|
'internals/contributing',
|
|
'extending/public-releases',
|
|
'extending/testing-rn',
|
|
'internals/linters',
|
|
'internals/device-identifiers',
|
|
...fbInternalOnly([
|
|
'fb/release-infra',
|
|
'fb/LauncherConfig',
|
|
'fb/hacking-on-launcher',
|
|
'fb/Flipper-fbsource-Pinning',
|
|
'fb/Flipper-Release-Cycle',
|
|
'fb/Add-Support-Group-to-Flipper-Support-Form',
|
|
'fb/Alerts',
|
|
'fb/bundling',
|
|
'fb/Electron-Upgrade',
|
|
'fb/flipper-analytics',
|
|
'fb/Navigation-Plugin-Development-Guide',
|
|
'fb/Oncall-Runbook',
|
|
'fb/sandcastle',
|
|
'fb/Star-Ratings',
|
|
'fb/sandcastle-overview',
|
|
'fb/error-logging',
|
|
'fb/scribe',
|
|
'fb/async-testing',
|
|
'fb/connections',
|
|
]),
|
|
],
|
|
},
|
|
};
|