Skip to content

Commit 7aeb3bb

Browse files
committed
fix: standardize dev docs
1 parent 4849c02 commit 7aeb3bb

8 files changed

Lines changed: 8 additions & 12 deletions

File tree

.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,3 @@ repos.generated.json
3737

3838
# Env
3939
*.env
40-
41-
# dev doc links
42-
content/*
43-
!content/general/
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

scripts/dev-link-docs.sh

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ set -e
44

55
PROJECT_ROOT=$(realpath "$(dirname "${BASH_SOURCE[0]}")/..")
66
PROJECT_DIR=$1
7-
LINK_PATH=$PROJECT_ROOT/content/$(basename $PROJECT_DIR)
7+
LINK_PATH="$PROJECT_ROOT/content/$(basename "$PROJECT_DIR")"
88

9-
if [ -z $PROJECT_DIR ]; then
9+
if [ -z "$PROJECT_DIR" ]; then
1010
echo "Usage: dev-link-docs <project_path>"
11+
exit 1
1112
fi
1213

1314
if [ ! -d "$PROJECT_DIR" ]; then
@@ -25,14 +26,13 @@ if [ ! -f "$PROJECT_DIR/docs.config.json" ]; then
2526
exit 1
2627
fi
2728

28-
mkdir -p $LINK_PATH
29+
mkdir -p "$LINK_PATH"
2930
echo "==> Linking docs/"
30-
ln -s $PROJECT_DIR/docs $LINK_PATH/docs
31+
ln -s "$PROJECT_DIR/docs" "$LINK_PATH/docs"
3132
echo "==> Linking docs.config.json..."
32-
ln -s $PROJECT_DIR/docs.config.json $LINK_PATH/docs.config.json
33+
ln -s "$PROJECT_DIR/docs.config.json" "$LINK_PATH/docs.config.json"
3334

3435
echo "==> Creating .gitignore..."
35-
touch $PROJECT_DIR/.gitignore
36-
echo "*" > $PROJECT_DIR/.gitignore
36+
printf '*' > "$LINK_PATH/.gitignore"
3737

38-
echo "Symlink to docs created for project $(basename $PROJECT_DIR)"
38+
echo "Symlink to docs created for project $(basename "$PROJECT_DIR")"

0 commit comments

Comments
 (0)