docs: set up v3 API ref. site

.github/workflows/manualRelease.yml

@@ -8,7 +8,7 @@ on:
 jobs:
  docs:
  needs: release
- if: github.ref_name == '3.0'
+ if: github.ref_name === '3.0' # TODO: remove this line after v3 GA(3.0 should be the main branch)
  uses: ./.github/workflows/publishDocs.yml
  release:
  runs-on: ubuntu-latest

.github/workflows/publishDocs.yml

@@ -25,14 +25,14 @@ jobs:
  run: |
  rm -rf docs
  git worktree prune
- git fetch origin v3-docs:v3-docs
- git worktree add docs v3-docs
+ git fetch origin gh-pages:gh-pages
+ git worktree add docs gh-pages
  npx typedoc --out docs/tmp
  cp -r docs/tmp/* docs/tmp/..
  rm -rf docs/tmp
  - name: send to git
  run: |
  cd docs
  git add .
- git commit -m 'docs: publishing v3-docs [skip ci]' --no-verify
- git push origin v3-docs --no-verify
+ git commit -m 'docs: publishing gh-pages [skip ci]' --no-verify
+ git push origin gh-pages --no-verify

README.md

@@ -24,7 +24,13 @@ Supported Salesforce APIs are the following:
 
 ## Documentation
 
-See documentation in <http://jsforce.github.io/> .
+See documentation in https://jsforce.github.io/
+
+v3 API reference:
+https://jsforce.github.io/jsforce/
+
+v1 API reference:
+https://jsforce.github.io/jsforce/doc/
 
 ## Releases