We will now use your working copies to let CodeStory know about your project's repositories, then optionally specify how your code is organized.

Instructions
CodeStory's most powerful feature is the ability to embed live views from your codebase into your notes.

Open the project and follow the instructions.

Instructions

Open the repository panel

... and add a repository.

Repository Panel

Locate your project's working copy

New Repository

If you successfully selected the working copy, CodeStory was able to use git to determine the remote:

New Repository

By clicking the Add Repository button:

  • the repository information (name and remote) is associated to your CodeStory project and saved to the cloud for your team as well,
  • the working copy location is saved locally, just for you.

Enter editing mode

We will now further configure the repository in order to specify the code sources.

This configuration step is of different nature than the previous one, as it is subject to change over time, depending on your git branches and commits!

Toggle the switch in the upper right corner of the window (or use Cmd-T).

Switch

A Project Settings icon is revealed. Click it.

Open the project settings

All your project repositories are shown here:

Project Settings
No source is set yet! Click to edit your repository settings.

Edit the repository settings

Project Settings
The repository settings were created with default settings, but no assumption is made regarding where your source files are located inside that repository.

Add a source

Click Add Source and locate the subfolder of your working copy where your source files live.

Project Settings

In this example, the source is simply set to be the root of the working copy.
Please note that /dist is excluded here using a glob exclusion.

If that makes sense, your can define additional sources, even nested ones.

For example, in that other project, 3 sources were defined.

PGPilot Settings
PGPilot
© 2021 CodeStory SAS – Paris, FRANCE contact