Skip to content

Commit 2a4dd71

Browse files
committed
add README
1 parent 5799d33 commit 2a4dd71

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# User Sync Tool Documentation
2+
3+
This documentation is built with [Hugo](https://gohugo.io/). To build the site
4+
for local development:
5+
6+
```
7+
$ hugo serve -D
8+
```
9+
10+
This watches all files in the `content` directory and incrementally builds the
11+
site when changes are detected. When working with non-English languages, this
12+
can sometimes render pages improperly or crash the server. If that happens, kill
13+
the server if it's still running (`ctrl+c`), start it again and refresh the
14+
page.
15+
16+
**NOTE:** The root documentation branch, `user-guide`, does not share commit
17+
history with `v2` or any other source code branches. We recommend cloning this
18+
branch to a separate directory. Switching between `user-guide`-derived branches
19+
and `v2`-derived branches in the same workspace may have undesirable side effects.
20+
21+
To clone `user-guide` to a separate directory:
22+
23+
```
24+
$ git clone -b user-guide https://github.com/adobe-apiplatform/user-sync.py.git user-sync.py-docs
25+
```

0 commit comments

Comments
 (0)