Commit b3047e59 authored by Grant's avatar Grant
Browse files

doc: improve dev setup instructions

parent df54e132

.gitlab-ci.yml

+13 −0
Original line number Diff line number Diff line
@@ -35,6 +35,19 @@ check outdated: 
  script:

    - npm outdated



lint markdown:

  stage: lint

  rules:

    - if: $CI_PIPELINE_SOURCE == "merge_request_event"

      changes:

        - "**/*.md"

  image: node:24-alpine

  before_script:

    - apk update && apk add git

    - corepack enable yarn && corepack prepare --activate

  script:

    - git diff --name-only $CI_MERGE_REQUEST_DIFF_BASE_SHA...HEAD | grep '\.md$' | xargs yarn dlx -p markdownlint-cli markdownlint



jest server:

  stage: test

  rules:

.gitlab/ci/wiki.yml

+1 −1
Original line number Diff line number Diff line
@@ -12,5 +12,5 @@ build-wiki: 
    - git remote add gitlab-wiki "https://ci:$CI_JOB_TOKEN@sc07.dev/sc07/canvas.wiki.git"

    - git status

    - git checkout main

    - git pull --rebase

    - git pull gitlab-wiki main --rebase

    - git push gitlab-wiki `git subtree split -P doc main`:main --force

.markdownlint.yaml

0 → 100644
+4 −0
Original line number Diff line number Diff line 
MD013: false

MD033:

  allowed_elements:

    - br

.markdownlintignore

0 → 100644
+2 −0
Original line number Diff line number Diff line 
node_modules

packages/*/node_modules
 
 No newline at end of file

doc/_sidebar.md

0 → 100644
+15 −0
Original line number Diff line number Diff line 
<!-- markdownlint-disable MD041 -->



- [Home](home.md)



### Contributing



- [Getting Started](contributing/getting-started.md)



### Deployment



- [Sentry](deploy/sentry.md)



### Development



- [Authentication](development/authentication.md)