Repository navigation
docs: overhaul consumer and maintainer documentation #95
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
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
6e32a1a
docs: overhaul consumer and maintainer documentation
divyarajmasani 362e1a6
ci(docs): deploy Pages using isolated docs-config branch
divyarajmasani 680be26
ci(docs): update Pages actions to Node 24 releases
divyarajmasani 6b14907
ci(docs): use shared documentation workflow
divyarajmasani 5d5e942
ci(docs): use public Docusaurus PoC workflow
divyarajmasani 4b60d60
Empty commit.
divyarajmasani 7cdb2e0
ci(docs): use dedicated Docusaurus build workflow
divyarajmasani db7debe
Empty commit.
divyarajmasani c497251
Empty commit.
divyarajmasani 7606210
docs: clarify documentation workflow path filters
divyarajmasani b55b752
docs: align loading examples and remove builder setup from README
divyarajmasani cec60e4
- Update the documentation build workflow.
divyarajmasani 856a580
- Removed test deployment branch from the workflow.
divyarajmasani File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| name: Documentation | ||
|
|
||
| on: | ||
| push: | ||
| # Temporary deployment test branch; remove after verification. | ||
| branches: [main] | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/documentation.yml' | ||
| pull_request: | ||
| branches: [main] | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/documentation.yml' | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| concurrency: | ||
| group: documentation-${{ github.event_name == 'pull_request' && github.ref || 'production' }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build documentation | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 15 | ||
| permissions: | ||
| contents: read | ||
| pages: read | ||
| steps: | ||
| - name: Checkout documentation | ||
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - name: Read Pages configuration | ||
| id: pages | ||
| if: >- | ||
| (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && | ||
| github.ref_type == 'branch' && github.ref_name == 'main' | ||
| uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 | ||
|
|
||
| - name: Build documentation | ||
| id: docs | ||
| uses: rtCamp/action-docusaurus-build@codex/documentation-workflow | ||
| with: | ||
| site-title: ${{ vars.DOCS_SITE_TITLE }} | ||
| site-config: ${{ vars.DOCS_SITE_CONFIG }} | ||
| site-url: ${{ steps.pages.outputs.origin }} | ||
| base-url: ${{ steps.pages.outputs.base_url && format('{0}/', steps.pages.outputs.base_path) || '' }} | ||
|
|
||
| - name: Upload GitHub Pages artifact | ||
| if: >- | ||
| (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && | ||
| github.ref_type == 'branch' && github.ref_name == 'main' | ||
| uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 | ||
| with: | ||
| path: ${{ steps.docs.outputs.build-directory }} | ||
| include-hidden-files: true | ||
|
|
||
| deploy: | ||
| name: Deploy documentation | ||
| needs: build | ||
| if: >- | ||
| (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && | ||
| github.ref_type == 'branch' && github.ref_name == 'main' | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.