-
Notifications
You must be signed in to change notification settings - Fork 348
New docs #1413
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
New docs #1413
Changes from all commits
Commits
Show all changes
40 commits
Select commit
Hold shift + click to select a range
9c82a66
TypeDoc setup
quietbits f1a7cbb
TS tags cleanup
quietbits f1c3be2
Update link syntax
quietbits b0ca28d
More comments cleanup
quietbits 599f9f3
Add @category
quietbits d1bda76
ESLint cleanup
quietbits afd39b2
Cleanup
quietbits 7656616
From category to file-path routing
quietbits 926e654
Comment cleanup
quietbits fbaf2a7
More source TSDoc cleanup
quietbits df5c8d9
Per-symbol rendering for reference docs
quietbits 55f237d
Tag rendering for reference docs
quietbits 7212ade
docs/ skeleton with landing page and placeholder guides
quietbits 72e0e38
LLMs sitemap and full-content bundle
quietbits 02bf30f
Astro/Starlight site scaffold
quietbits 0ccb73e
Polish LLMs head link, public/ bundles, robots.txt
quietbits d7778cf
Retire JSDoc pipeline
quietbits 1f8b71a
Refresh CONTRIBUTING with docs guide
quietbits 61debaa
Render class/interface members and pin source links to evergreen ref
quietbits 6cd8b1a
Trim CI: vitest coverage scope and bundle_size workflow
quietbits b95a15e
Fix tests
quietbits 80512a1
UI polishes
quietbits a9c827e
Make docs site agent-friendly; centralize site config
quietbits 60187f6
Fixed URL in MD siblings
quietbits 72276b7
.htaccess file
quietbits 304d2fd
readme updates + UI fix
quietbits 88c4e73
Add sub-page description
quietbits fef7e60
htaccess update
quietbits 2746e95
Merge branch 'modernization' of https://github.com/stellar/js-stellar…
quietbits 6f30ce6
Apply SDS theme
quietbits 5a3de34
Apply SDS fonts
quietbits 18a43b5
Cleanup
quietbits d016c8b
Use default font size
quietbits ac0a180
Update tests action
quietbits f327fc3
Upgrade playwright + attempt to fix tests for 24
quietbits 9d70c37
Fix build docs script
quietbits c49dd12
Updated version guide
quietbits 700e55b
Update wording
quietbits ab91814
Fix dead anchor links
quietbits 56645e6
Update readme
quietbits 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 was deleted.
Oops, something went wrong.
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,54 @@ | ||
| name: Docs build | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| check: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup pnpm | ||
| uses: pnpm/action-setup@v4 | ||
|
|
||
| - name: Install Node (22.x) | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22.x" | ||
| cache: pnpm | ||
| cache-dependency-path: pnpm-lock.yaml | ||
|
|
||
| - name: Enable Corepack | ||
| run: corepack enable | ||
|
|
||
| - name: Install Dependencies | ||
| run: pnpm install --frozen-lockfile --network-concurrency 1 | ||
|
|
||
| - name: Cache Astro build | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: .astro | ||
| key: astro-${{ hashFiles('astro.config.mjs', 'pnpm-lock.yaml') }} | ||
|
|
||
| - name: Build reference docs | ||
| run: pnpm docs:reference | ||
|
|
||
| - name: Build llms.txt bundles | ||
| run: pnpm docs:llms | ||
|
|
||
| - name: Verify generated docs are up to date | ||
| run: git diff --exit-code -- docs/ | ||
|
|
||
| - name: Generate robots.txt from config | ||
| run: pnpm docs:robots | ||
|
|
||
| - name: Generate .htaccess from config (Apache hosts only) | ||
| run: pnpm docs:htaccess | ||
|
|
||
| - name: Build Starlight site | ||
| run: pnpm docs:site |
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,63 @@ | ||
| name: Docs deploy | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| concurrency: | ||
| group: pages | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup pnpm | ||
| uses: pnpm/action-setup@v4 | ||
|
|
||
| - name: Install Node (22.x) | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22.x" | ||
| cache: pnpm | ||
| cache-dependency-path: pnpm-lock.yaml | ||
|
|
||
| - name: Enable Corepack | ||
| run: corepack enable | ||
|
|
||
| - name: Install Dependencies | ||
| run: pnpm install --frozen-lockfile --network-concurrency 1 | ||
|
|
||
| - name: Cache Astro build | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: .astro | ||
| key: astro-${{ hashFiles('astro.config.mjs', 'pnpm-lock.yaml') }} | ||
|
|
||
| - name: Build docs | ||
| run: pnpm run docs | ||
|
|
||
| - name: Upload Pages artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: dist/site | ||
|
|
||
| deploy: | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
This file was deleted.
Oops, something went wrong.
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.
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.