Deploy latest documentation updates to staging#510
Merged
Conversation
Update Stride Shader Tools extension links to new publisher
* Initial work on types of script * Mostly finished type specific pages (except one section for async) * Finished async script * Updated types of script index * Fixed minor spelling * Fixed wrong script types in examples and added api references * Fixed mistakes * Small mistake * Added a warning for Task.Run
* Initial work on rewriting the "get started" section * Merged changed from master * Changed path for the requirements file on contributors major release workflow page * Added images * Updates links in pages * Updated install-stride troubleshooting * Fixes * Fixed unity page not having a href in toc * Re-added the visual studio extension page * Updated script links in key concept * Added manage versions page * Fixed links and headings * Implemented suggestions * Deleted an unused image
Clarify a couple of points, make it clear that we're open to any contribution
…n build automation (#494) * feat: BuildDocs.ps1 - Add -SkipApiBuilding switch - Add new -SkipApiBuilding switch to skip API doc generation - Update help documentation, parameter list, and examples - Bypass API prompts and steps when -SkipApiBuilding is set - Ensure $API is set to $false if skipping API build - Improve script flexibility for CI and manual usage * build: build-all.bat - Forward args to PowerShell script - Pass all command-line arguments (%*) from build-all.bat to BuildDocs.ps1 - Allow users to specify extra parameters when invoking the batch file - Move error handling logic to the same line as the PowerShell command for clarity * refactor: Refactor docs workflow to use composite action - stride-docs-github.yml - Replace inline setup/build steps with new composite action (action.yml) for improved maintainability - stride-docs-github.yml - Add workflow_dispatch inputs: skipPdfBuilding and skipApiBuilding, allowing selective skipping of PDF/API doc builds - action.yml - Implement Setup Stride composite action to encapsulate .NET setup, repo checkouts, DocFX install, and build logic - action.yml - Dynamically construct build arguments for build-all.bat based on skip options - Removes duplicated logic and centralizes workflow setup for easier updates and reuse * ci: Remove unused common-setup workflow - common-setup.yml - Delete unused GitHub Actions workflow for Stride Docs/Stride setup - Stride.Docs.sln - Remove reference to common-setup.yml from Solution Items - Workflow was no longer used and its removal cleans up the repository * ci: Remove Stride Docs checkout step from workflow - action.yml - Remove actions/checkout@v6 step for Stride Docs - Eliminate checkout path and Git LFS configuration - Retain version setting in docfx.json step - Simplifies workflow by removing unnecessary repository checkout * ci: stride-docs-github.yml - Add checkout step for docs job - Add "Checkout Stride Docs" step using actions/checkout@v6 - Specify checkout path with DOCS_PATH environment variable - Enable Git LFS support for large file handling - Ensures docs are available for subsequent workflow steps * ci: stride-docs-github.yml - Update setup-stride action path - Change setup-stride action path to ./stride-docs/.github/actions/setup-stride - Reflects relocation or restructuring of action directory - All input parameters to the action remain unchanged * ci: Update Stride Docs checkout handling in workflows - action.yml - Add step to check out Stride Docs with actions/checkout@v6, specifying path and enabling Git LFS * ci!: Remove stride-docs-wiki.yml workflow * ci: Move Stride Docs checkout to stride-docs-github.yml - action.yml - Remove .NET SDK setup and Stride Docs checkout steps - stride-docs-github.yml - Restore and enable Stride Docs checkout step with correct path and LFS * ci!: Revamp stride-docs-test-build.yml workflow - stride-docs-test-build.yml - Add workflow_dispatch inputs: skipPdfBuilding and skipApiBuilding to control PDF/API build steps - stride-docs-test-build.yml - Remove .NET SDK setup, manual repo checkout, and docfx.json version update steps - stride-docs-test-build.yml - Integrate new composite action setup-stride for global setup and build logic - stride-docs-test-build.yml - Remove explicit DocFX install and documentation build from main workflow - stride-docs-test-build.yml - Retain artifact compression and upload steps * ci: Refactor GitHub Pages deployment workflow - stride-docs-github.yml - Switch to actions/deploy-pages@v5 for deployment - stride-docs-github.yml - Explicitly set permissions for contents, pages, and id-token - stride-docs-github.yml - Add concurrency group to prevent overlapping deployments - stride-docs-github.yml - Split build and deploy into separate jobs - stride-docs-github.yml - Use actions/upload-pages-artifact@v4 to upload build output - stride-docs-github.yml - Update setup-stride action path to use DOCS_PATH - stride-docs-github.yml - Align workflow with GitHub's recommended static site deployment approach * ci: stride-docs-test-build.yml - Use dynamic setup action path - Update "Global Setup" action path to use ${{ env.DOCS_PATH }} - Improves flexibility for different documentation paths - Enhances maintainability and reusability of the workflow * ci: Update setup-stride action path in workflows - stride-docs-github.yml - Change setup-stride action path from dynamic (${{ env.DOCS_PATH }}) to hardcoded ./stride-docs/.github/actions/setup-stride - stride-docs-test-build.yml - Apply the same path update for consistency * ci: stride-docs-github.yml - Set explicit permissions for deploy - Add contents: read, pages: write, and id-token: write permissions - Ensure required access for GitHub Pages deployment and OIDC - Improves workflow security and clarity * ci: stride-docs-github.yml - Remove permissions from deploy job * ci: stride-docs-test-build.yml - Upload _site dir, not ZIP - Remove step that compressed _site output into a ZIP file - Upgrade upload-artifact action from v6 to v7 * ci!: Use boolean workflow inputs for skipPdfBuilding/API - stride-docs-github.yml - Change skipPdfBuilding and skipApiBuilding inputs from string choices ("Yes"/"No") to booleans (true/false) - stride-docs-test-build.yml - Update input types and defaults to boolean true - action.yml - Update input descriptions and defaults to reflect boolean usage; update build step logic to check for 'true' instead of 'Yes' - action.yml - Pass workflow inputs using ${{ inputs.skipPdfBuilding }} and ${{ inputs.skipApiBuilding }} for consistency
* showcase redesign * Update games-and-demos.md
- Refactor "Released Games" section to use Bootstrap-style card grid layout - Replace inline CSS flexbox containers with row, col-xxl-4, col-md-6, and card classes - Expand game descriptions for clarity and detail - Add "One Late Night: Remake" and "Banpo's Bridge Wondrous Worlds" with images and links
* Started work on queries * Finished raycasts page (hopefully) * Improved spelling * Cleaned up raycasts page * Slowly getting there * Finished query pages * Added missing info * Polish * Fixed mistakes * Small mistake in sweepcasts * Fixed distance for sweepcasts * Reworded a section to make it more clear * Minor improvements * Updated redirect * Change to hitinfo * Fixed minor errors * Removed the second distance parameter from raycasts
* Initial work on rewriting the files and folders section * Fixed incorrect yaml on package pages * Added external packages pages * Removed incorrect information from cached files * Fixed errors * Added the building section * Updated files and folders index * Added a mention of the compiller app to creating a package * Added automatic cleanup to the build cleanup page * Fixed errors * Added redirecting to unused pages * Removed engine package page to avoid conflicting search results * Fixed problems with confusing naming + others * Added a note about custom nuget hosts * Removed the engine project page * Added file structure visualizations * Removed broken image * Added platform packages image * Added dependency visualizations * Finished docs * Added badges * Updated gitattributes * Removed the proton not working check, since it might be working * Fixed a lot of errors * Updataed gitignore * Minor fixes
* test: action.yml - Update workflow to build and install DocFX from fork Switch workflow to use VaclavElias/docfx temp-fix branch for DocFX. Add steps to restore npm dependencies, build site templates, add nightly NuGet source, and build/install DocFX 2.9-stride locally. Retain previous DocFX install steps as comments for reference. * fix: action.yml - Set shell to pwsh for npm and NuGet steps in workflow Added shell: pwsh to npm install, npm build, and NuGet source steps to ensure these actions run with PowerShell in the workflow. This improves consistency and compatibility across the build process. * test: action.yml - Add MSBuild SDK resolver step to GitHub Actions workflow Introduced a PowerShell step after .NET SDK setup to set DOTNET_ROOT and MSBuildSDKsPath environment variables. The step outputs their values and ensures MSBuildSDKsPath exists, improving environment configuration for subsequent workflow steps. * test: Set MSBuildEnableWorkloadResolver in action.yml - Add MSBuildEnableWorkloadResolver=false to GitHub Actions env - Output the variable to logs for visibility - Disables MSBuild workload resolver during workflow execution * docs: docfx.json - Enable C# preview features for docs - Added "LangVersion": "preview" to Stride.BepuPhysics and Stride.Physics project configurations - Allows use of C# preview language features in documentation generation * test: Some projects removed * fix: Comma removed * docs: docfx.json - Add more projects to metadata config - Add multiple Stride engine and core projects to the files array - Add asset and physics projects with net10.0-windows7.0 target - Update metadata structure for improved documentation coverage * feat: action.yml - Add Prebuild Stride step to workflow - Add "Prebuild Stride" step to run dotnet build on build\Stride.sln - Set configuration to Release and working directory to stride - Use PowerShell as the shell for the build step * docs: docfx.json - Update target framework and noRestore - Set noRestore to true to disable package restore * docs: docfx.json - Allow compilation errors in build - Set allowCompilationErrors to true in docfx.json - Enables documentation build even if code samples have errors - Useful for illustrative or incomplete code snippets * test: Add step Install MSVC ARM64/ARM64EC build tools * feat: Add stride-branch input and update action versions - Add stride-branch input to action.yml and stride-docs-test-build.yml - Use stride-branch input in checkout step instead of hardcoded master - Update step names in action.yml for clarity (- Temporary) - Upgrade upload-artifact to v7 in stride-docs-staging-azure.yml - Upgrade download-artifact to v8 in stride-docs-staging-azure.yml - Pass stride-branch input to setup-stride in stride-docs-test-build.yml * docs: Improve CI workflows and add composite setup action - Add NuGet dependency caching in action.yml for faster builds - Comment out MSBuild SDK resolver and MSVC ARM64 tool steps in action.yml - Update stride-docs-test-build.yml to use windows-2025-vs2026 runner - Introduce action-backup.yml composite action for unified setup - Centralize .NET, repo checkout, and DocFX install steps - Add options to skip PDF or API building in the new action * docs: Update DocFX workflow, add release-candidate action - Comment out custom DocFX build/install in action.yml - Revert to installing DocFX 2.78.5 via dotnet tool update - Add action-release-candidate.yml composite action - New action sets up .NET, checks out Stride/DocFX, builds DocFX - Supports skipping PDF/API build, adds dependency caching and template build * feat: action.yml - Enable custom DocFX build workflow - Uncomment steps to checkout, build, and install DocFX from source - Use a specific branch of the DocFX repository for builds - Restore npm dependencies and build site templates - Add nightly NuGet source for dependencies - Comment out installation of prebuilt DocFX version 2.78.5 - Ensure workflow uses custom-built DocFX instead of release * chore: stride-docs-test-build.yml - Add permissions block - Add permissions block with contents: read to workflow file - No other changes to build job or configuration * feat: stride-docs-github.yml - Add stride-branch input, update runner - Add stride-branch input to allow branch selection (default 'master') - Change build runner to windows-2025-vs2026 - Pass stride-branch to setup-stride action - Update upload-pages-artifact to v5 * ci: Update workflows for new setup and config options - Add workflow_dispatch inputs for PDF/API skipping and branch selection - Switch build environment to windows-2025-vs2026 - Consolidate setup/checkout into custom setup-stride action - Remove legacy steps and manual DocFX install - Update artifact handling to upload built site directory - Improve CI configurability and maintainability * refactor: Remove Setup Stride composite action steps - Remove inputs and runs sections from action-backup.yml - Remove inputs and runs sections from action-release-candidate.yml - Eliminate reusable Setup Stride composite action and all related steps * docfx.json - Enforce restore and compilation checks - Set noRestore to false to enable package restore - Set allowCompilationErrors to false to require successful compilation * chore: docfx.json - Remove LangVersion: preview properties - Remove "LangVersion": "preview" from Stride.BepuPhysics and Stride.Physics project properties - Projects will no longer use C# preview features for docs generation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
No description provided.