Skip to content
Zipline Zipline Service Documentation

    Section 1 - Set up your workspace

    Use the information on this page to get your computer ready for authoring topics.

    Prerequisites

    Section titled “Prerequisites”

    You need a Zipline GitHub account and write access to ZiplineTeam/service_docs.

    I have a Zipline GitHub account but I need write access

    Post a message in #AskIT asking for write access to ZiplineTeam/service_docs and include your Zipline GitHub username.

    I need a Zipline GitHub account and I also need write access

    Post a message in #AskIT asking for a Zipline GitHub account and write access to ZiplineTeam/service_docs.

    Set Up Your Workspace

    Section titled “Set Up Your Workspace”

    1. Install Git and Node.js LTS: Windows setup or Mac setup.

    2. Install Visual Studio Code (VS Code).

      Steps
      1. Download Visual Studio Code from the official VS Code download page.
      2. Choose the installer for your operating system.
      3. On Windows, select these installer options when they appear:
        • Add “Open with Code” action
        • Add to PATH
        • Register Code as an editor for supported file types
      4. Open VS Code after installation.

    3. Install the VS Code Codex extension.

      Steps

      1. In VS Code, open the Extensions view.

        Extensions view exampleVisual Studio Code with the Extensions view selected in the Activity Bar.

      2. Search for Codex.

        Codex search exampleVisual Studio Code Extensions view showing a search for the Codex extension.

      3. Install the Codex extension from OpenAI.

      4. Sign in when the extension asks you to.

      5. Open the Codex chat panel.

        1. Press Ctrl+Shift+P to open the Command Palette.
        2. Type Codex: Open Codex Sidebar.
        3. Select Codex: Open Codex Sidebar.

      You can also use OpenAI’s Codex IDE extension setup page.

    4. Sign in to GitHub in VS Code.

      Steps
      1. In VS Code, open the Accounts menu.
      2. Choose Sign in with GitHub.
      3. Authorize VS Code in the browser when prompted.

      This helps VS Code connect your local repo work to your GitHub account.

    5. Clone the repo in VS Code.

      Steps

      1. Open the Source Control view.

        Source Control view exampleVisual Studio Code Activity Bar with an arrow pointing to the Source Control icon.

      2. In the Source Control view, click the three dots, then select Clone.

        Clone option exampleVisual Studio Code Source Control menu with an arrow pointing to the three-dot menu and the Clone option highlighted.

      3. Paste https://github.com/ZiplineTeam/service_docs.git.

      4. Choose a local folder, such as C:\GitHub on Windows.

      5. Open the cloned service_docs folder when VS Code asks.

      6. If cloning fails with a permission error, confirm that you are signed in to the right GitHub account and request access in #AskIT.

    6. Install site dependencies.

      Steps
      1. In VS Code, open a terminal with Terminal > New Terminal.
      2. Confirm the terminal prompt is in the main service_docs folder.
      3. Run npm ci --prefix site from the service_docs folder.
      4. Wait until the command finishes and the terminal shows a new prompt.
      5. If the terminal says npm is not recognized, Node.js is not installed correctly. Use Windows setup or Mac setup to install Node.js LTS, then try again.

    7. Ask Codex to confirm the setup.

      Paste this into the Codex chat panel:

      Please check that this service_docs workspace is ready for authoring.
      Confirm the current git branch, whether the working tree is clean, whether site dependencies are installed, and how I can start the local preview.
      Do not edit files yet.

    When Codex confirms the basics, continue to Start the local preview.