docs.json

{
  "name": "Pieces for Developers",
  "theme": "#BFC5EA",
  "googleTagManager": "GTM-K8C6QWB",
  "logo": "/assets/pieces_dark.png",
  "socialPreview": "/assets/pfd_preview.png",
  "logoDark": "/assets/pieces_light.png",
  "favicon": "/assets/pieces_dark.png",
  "docsearch": {
    "appId": "KTOXFODR65",
    "apiKey": "79c81e52460257d3761ea38438e29637",
    "indexName": "pieces",
    "insights": true
  },
  "anchors": [
    {
      "title": "Visit pieces.app",
      "icon": "home",
      "link": "https://pieces.app"
    },
    {
      "title": "Coding Blog",
      "icon": "newspaper",
      "link": "https://code.pieces.app/blog"
    },
    {
      "title": "Product Updates",
      "icon": "pencil",
      "link": "https://code.pieces.app/updates"
    },
    {
      "title": "Company News",
      "icon": "newspaper",
      "link": "https://news.pieces.app"
    },
    {
      "title": "YouTube Channel",
      "icon": "youtube",
      "link": "https://youtube.com/@getpieces"
    },
    {
      "title": "Discord",
      "icon": "discord",
      "link": "https://discord.gg/getpieces"
    },
    {
      "title": "Open Source",
      "icon": "unlock",
      "link": "https://github.com/pieces-app/opensource"
    },
    {
      "title": "Contact Support",
      "icon": "headset",
      "link": "https://getpieces.typeform.com/to/mCjBSIjF#page=docs-sidebar"
    }
  ],
  "sidebar": [
    ["\uD83D\uDEE0️️ Installation", [
      ["Getting Started", "/installation-getting-started/what-am-i-installing"],
      ["Windows", "/installation-getting-started/windows"],
      ["MacOS", "/installation-getting-started/macos"],
      ["Linux", "/installation-getting-started/linux"]
    ]],
    ["\uD83D\uDD0C Apps & Plugins", [
      ["Chrome Extension", "/extensions-plugins/chrome"],
      ["Edge Addon", "/extensions-plugins/edge"],
      ["Firefox Addon", "/extensions-plugins/firefox"],
      ["Jetbrains Plugin", "/extensions-plugins/jetbrains"],
      ["VS Code Extension", "/extensions-plugins/vscode"],
      ["Azure Data Studio", "/extensions-plugins/azuredatastudio"],
      ["Obsidian Plugin", "/extensions-plugins/obsidian"],
      ["JupyterLab Extension", "/extensions-plugins/jupyterlab"],
      ["Microsoft Teams App", "/extensions-plugins/teams"]
    ]],
    ["⚙️ Product Features", [
      ["Auto Enrichment", "/features/auto-enrichment"],
      ["Back Up & Restore", "/features/back-up-and-restore"],
      ["Code Completion", "/features/code-completion"],
      ["Creating & Generating Code", "/features/creation-and-generation"],
      ["Global Search", "/features/global-search"],
      ["Keyboard Shortcuts", "/features/keyboard-shortcuts"],
      ["Material Storage & Management", "/features/managing-saved-materials"],
      ["One Click Sharing", "/features/one-click-snippet-sharing"],
      ["Pieces Copilot", "/features/pieces-copilot"],
      ["Search Modes", "/features/search-modes"],
      ["Snippet Transformations", "/features/transforming-snippets"],
      ["User Settings", "/features/user-settings"],
      ["Workflow Activity", "/features/workflow-activity"]
    ]],
    ["✨ Highlights & Benefits",[
      ["Connecting to a Remote Pieces OS Instance", "/product-highlights-and-benefits/connecting-to-a-remote-pieces-os-instance"],
      ["In-Project Snippet Discovery", "/product-highlights-and-benefits/in-project-snippet-discovery"],
      ["Privacy & Security", "/product-highlights-and-benefits/privacy-security-data"],
      ["Save Developer Materials", "/product-highlights-and-benefits/saving-useful-developer-materials"],
      ["Save Screenshots & Extract Code", "/product-highlights-and-benefits/saving-screenshots"],
      ["Saving To/From Github Gists", "/product-highlights-and-benefits/saving-to-and-from-github-gists"],
      ["Snippet Collections", "/product-highlights-and-benefits/collections"]
    ]],
    ["\uD83D\uDCDA Use Cases", [
      ["Reduce Endless Google Searching", "/use-cases/countless-google-searches"],
      ["Onboard New Developers", "/use-cases/onboard-new-developers"],
      ["Resurface Additional Context", "/use-cases/resurfacing-additional-context"]
    ]],
    ["\uD83C\uDF0E Community & More", [
      ["Frequently Asked Questions", "/faq"],
      ["Privacy Policy", "/privacy-policy"],
      ["Terms", "/terms"],
      ["Our Community", "/our-community"]
    ]]
  ],
  "variables": {
    "versions": {
      "pfd": "v2.8.2",
      "chrome": "v2.8.3",
      "jetbrains": "v7.0.0",
      "vscode": "v1.9.1",
      "obsidian": "v1.8.1",
      "jupyterlab": "v1.8.1",
      "pieces_os": "v7.0.1",
      "edge": "v2.8.3",
      "teams": "v1.1.0",
      "firefox": "v2.8.3",
      "azureds": "v1.8.0"
    },
    "links": {
      "website": {
        "home": "https://pieces.app",
        "pfd_desktop_install": "https://pieces.app",
        "pfd_linux_install": "https://pieces.app/getting-started/linux/",
        "release_notes": "https://code.pieces.app/updates",
        "blog": "https://code.pieces.app/blog"
      },
      "extensions": {
        "chrome": "https://chrome.google.com/webstore/detail/pieces-save-code-snippets/igbgibhbfonhmjlechmeefimncpekepm",
        "jetbrains": "https://plugins.jetbrains.com/plugin/17328-pieces--save-search-share--reuse-code-snippets",
        "vscode": "https://marketplace.visualstudio.com/items?itemName=MeshIntelligentTechnologiesInc.pieces-vscode",
        "obsidian": "https://obsidian.md/plugins?id=pieces-for-developers",
        "jupyterlab":  "TODO: There is no install link for JupyterLab, not sure what is ideal here",
        "edge": "https://microsoftedge.microsoft.com/addons/detail/pieces-save-code-snippet/hglfimcdgonaeeobjckfdabcldfidmim",
        "teams": "https://teams.microsoft.com/dl/launcher/launcher.html?url=%2F_%23%2Fl%2Fapp%2F789f23b3-d882-45ca-b3a3-de7f850656ea%3Fsource%3Dapp-details-dialog&type=app&deeplinkId=a5fe0a60-b3a1-42a2-9a57-a5ec71696573&directDl=true&msLaunch=true&enableMobilePage=true&suppressPrompt=true",
        "firefox": "https://addons.mozilla.org/en-US/firefox/addon/pieces-save-code-from-the-web/",
        "azureds": "https://builds.pieces.app/stages/staging/plugin_vscode/ads-vsix/download"
      },
      "snippets": {
        "python": {
          "snippet": "https://python.pieces.cloud/?p=8711459369",
          "collection": "https://code.pieces.app/collections/python"
        }
      },
      "external": {
        "forms": {
          "feedback": "https://getpieces.typeform.com/to/mCjBSIjF",
          "join_beta": "https://getpieces.typeform.com/to/XGGlUqEI"
        }
      },
      "installation": {
        "macos_bigsur": "https://apps.apple.com/id/app/macos-big-sur/id1526878132?mt=12",
        "pieces_pkg": "https://builds.pieces.app/stages/production/macos_packaging/pkg/download",
        "pieces_suite_manager": "https://builds.pieces.app/stages/production/pieces_suite_windows/appinstaller/download",
        "windows_versions": "https://www.catalog.update.microsoft.com/Search.aspx?q=windows%2010%201809",
        "ubuntu_versions": "https://releases.ubuntu.com/18.04",
        "jupyterlab": "https://jupyterlab.readthedocs.io/en/latest/getting_started/installation.html",
        "localhost": "pieces://"
      },
      "videos": {
        "getting_started_desktop": "https://youtu.be/bczfW9wk8Bo",
        "youtube_channel": "https://www.youtube.com/@getpieces",
        "snippet_discovery": "https://youtu.be/G6vb1USw-30"
      },
      "socials": {
        "twitter": "https://twitter.com/getpieces",
        "linkedin": "https://www.linkedin.com/company/getpieces/",
        "support_email": "mailto:support@pieces.app"
      },
      "internal": {
        "installation_getting_started": {
          "macos": "https://docs.pieces.app/i3nstallation-getting-started/macos",
          "windows": "https://docs.pieces.app/installation-getting-started/windows",
          "linux": "https://docs.pieces.app/installation-getting-started/linux",
          "what": "https://docs.pieces.app/installation-getting-started/what-am-i-installing"
        },
        "product_highlights": {
          "save_materials": "https://docs.pieces.app/product-highlights-and-benefits/saving-useful-developer-materials",
          "save_screenshots": "https://docs.pieces.app/product-highlights-and-benefits/saving-screenshots",
          "in_project_snippet_discovery": "https://docs.pieces.app/product-highlights-and-benefits/in-project-snippet-discovery",
          "import_gists": "https://docs.pieces.app/product-highlights-and-benefits/import-gists-from-github"
        },
        "context_awareness_engine": {
          "origin_details": "https://docs.pieces.app/features/auto-enrichment#origin-details",
          "ai_smart_descriptions": "https://docs.pieces.app/features/auto-enrichment#ai-smart-descriptions",
          "related_links_resources": "https://docs.pieces.app/features/auto-enrichment#related-links-external-resources--reference-materials",
          "ai_generated_labels": "https://docs.pieces.app/features/auto-enrichment#ai-generated-smart-labels",
          "related_people": "https://docs.pieces.app/features/auto-enrichment#related-people",
          "smart_warnings": "https://docs.pieces.apps/features/auto-enrichment#smart-warnings"
        },
        "global_search_suggestion_reuse": {
          "global_search": "https://docs.pieces.app/features/global_search",
          "search_settings": "https://docs.pieces.app/features/global-search#adjusting-settings-for-optimal-search-results",
          "sort_scope_relevant": "https://docs.pieces.app/features/global-search#sorting-by-realtime-or-scope-relevant-suggestions",
          "workflow_activity_stream": "https://docs.pieces.app/features/workflow-activity"
        },
        "personalized_link_sharing": {
          "single_click_snippet_sharing": "https://docs.pieces.app/features/one-click-snippet-sharing",
          "save_for_offline": "https://docs.pieces.app/features/one-click-snippet-sharing#saving-a-shared-material",
          "share_via_github_gist": "https://docs.pieces.app/one-click-snippet-sharing#share-via-github-gist"
        },
        "additional_features_and_settings": "https://docs.pieces.app/one-click-snippet-sharing",
        "join_our_community": "https://docs.pieces.app/join-our-community",
        "faqs": "https://docs.pieces.app/frequently-asked-questions"
    }
    }
  }
}