Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: set up v3 API ref. site #1425

Merged
merged 2 commits into from
May 22, 2024
Merged

docs: set up v3 API ref. site #1425

merged 2 commits into from
May 22, 2024

Conversation

cristiand391
Copy link
Member

@cristiand391 cristiand391 commented May 20, 2024

Updates typedoc workflow to push site build to gh-pages.
I pushed the first build from local to confirm it Jekyll build worked while retaining the v1 API ref at doc:
https://github.com/jsforce/jsforce/tree/gh-pages

Changed GH pages it to serve from the root:
Screenshot 2024-05-20 at 5 47 53 PM

v3: https://jsforce.github.io/jsforce/
v1: https://jsforce.github.io/jsforce/doc/

When users click on API Reference in https://jsforce.github.io/ they will get to the v3 API ref. The main page is the readme which links to v1 ones.
changed here: jsforce/jsforce.github.io@63913c0

@W-15807592@

@WillieRuemmele
Copy link
Collaborator

✅ : was coincidentally using these docs this A.M. for something else
✅ : Bulk V2 Api only in version 3
❓ : there's an 'edit this page' block hidden under 'advanced' in V2
image

@WillieRuemmele
Copy link
Collaborator

✅: edit this page now in footer

@WillieRuemmele WillieRuemmele merged commit af8a10e into 3.0 May 22, 2024
17 checks passed
@cristiand391 cristiand391 deleted the cd/api-ref branch May 22, 2024 23:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants