As collaborators on a Map, you have access to tools to help your team onboard to the codebase, understand team ownership, learn key flows, and more.
Real-time Collaboration allows multiple users to make changes to a Map at the same time. Users actively collaborating in the Map are represented with avatars containing their initial and a cursor that follows their activity on the Map.
Maps have three Modes: Edit, View, and Playground.
|Mode||How it works||Real-time collaboration||What Map-Permission is required|
|View||Read only: You can view the map, but you cannot make any edits||Yes. You will see cursors of other users on the same map||Any|
|Edit||Read/Write: You can make any edits.||Yes. All edits are immediately saved and shared.||Write|
|Playground||Think of this like a sandbox. You can make edits, freely experiment, but nothing is saved.||No. This is a one-player only mode, and no changes are saved.||Any|
Tours are a way to create asynchronous, visual walkthroughs on a Map. Tours can be used for anything that comes to mind, showing where features are, tricky flows through files, helping to debug, and more.
- Click on the Tours icon on your left toolbar.
- Click "Add a Tour."
- Provide a name for the Tour.
- Click "Add a Step."
- Click the node in the Map where you want to place the first step of your Tour.
- Add a description to the Tour step.
- Go back to Step 4 and create as many Tour steps as you'd like!
Tours will automatically display at the top of your Map interface.
To navigate between multiple Tours:
- Select the dropdown next to the name of your Tour.
- Select the Tour you would like to view.
Click on the overflow button (•••) in the toolbar to:
- Add a second Tour.
- Rename a Tour.
- Delete a Tour.
The legend is a panel in the upper-right corner of the Map. Here you can choose colors and labels that you can apply to files or folders in your Map.
To add a new Label to the legend:
- Click “Add a new label.”
- Click on the placeholder text “New Label” to edit the text for the label at any time.
- Click the colored tile on the left to select a color for files and folders with that Label.
- You can use labels to designate and color-code team ownership, indicate different codebase features, mark hotspots or tech debt, or whatever would be useful to you.
To assign colors to files or folders:
- Click the Color tool, then select the color you’d like to use.
- Click on the files or folders you want to paint with that selected color.
By right-clicking on a file or folder, you'll get the following options:
This will hide the items you've selected from the Map.
This will hide all items that are not selected.
This will show all files and folders.
This will allow annotating items.
Use the Notes tool to add additional context to any file and folder.
- Click on the “Notes” tool.
- Click on the file or folder you would like to annotate.
- Type your note, then press "Enter" on your keyboard to add it to the file or folder.
Notes on folders are available only when the folder is collapsed.
Users with "write" access can participate in a real-time chat experience on any file or folder in your Codebase Map.
When you select any node in the map, you'll see a chat bubble on the right side of the selected node. Click the chat bubble to begin or continue a conversation.
If there is an existing conversation on a node, you will see the chat icon inside the node along the right edge.
You can select the node, then click the chat bubble that appears to view the existing chat.
When there are comments anywhere in a map, a chat icon will appear in the upper-right corner of the header. You can also click that chat icon to see all existing comment threads. Click a thread to jump to the file or folder where the conversation is taking place.
When there are unread comments either on a specific node or anywhere in the map, the appropriate chat icon will have a red dot.
To create a copy of a Map, click on the overflow button (•••), then select “Duplicate.”
Updated 25 days ago