generated from slatedocs/slate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(swimm): create doc: A flow in the code
- Loading branch information
Showing
2 changed files
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: A flow in the code | ||
--- | ||
## Introduction | ||
|
||
This doc describes the {{SUBJECT}} flow in our system. We will follow its implementation across the various locations so you can understand how the different parts create the full picture. | ||
|
||
## Following the flow | ||
|
||
<SwmSnippetPlaceholder> | ||
|
||
Select the first step where the flow begins - e.g., the entry point, or an API call. | ||
|
||
</SwmSnippetPlaceholder> | ||
|
||
{{Keep adding snippets from the next steps of the flow}} | ||
|
||
## Things to note | ||
|
||
{{Who uses this flow and when?}} | ||
|
||
<SwmMeta version="3.0.0" repo-id="Z2l0aHViJTNBJTNBZGV2ZWxvcGVyLmZzcyUzQSUzQW1hbnVjcjYxOQ==" repo-name="developer.fss"><sup>Powered by [Swimm](https://app.swimm.io/)</sup></SwmMeta> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"repo_id": "Z2l0aHViJTNBJTNBZGV2ZWxvcGVyLmZzcyUzQSUzQW1hbnVjcjYxOQ==" | ||
} |