Merged
Conversation
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
…into refresh-branding
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: Ryan Luu <ryan.luu@ryanluu.dev>
Signed-off-by: Ryan Luu <ryan.luu@ryanluu.dev>
Signed-off-by: GitHub <noreply@github.com>
…into refresh-branding
Signed-off-by: Ryan Luu <ryan.luu@ryanluu.dev>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR modernizes Satchel's branding and streamlines its documentation infrastructure. The changes focus on updating the project's visual identity, simplifying the build process, and consolidating documentation resources.
- Updates branding elements including logos, favicons, and documentation URLs from
satchel.ryanluu.devtosatchel.luau.page - Streamlines documentation workflow by removing markdown linting and simplifying the MkDocs deployment process
- Reorganizes and updates documentation content with improved formatting and updated links
Reviewed Changes
Copilot reviewed 22 out of 59 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Simplified layout with new branding, added sponsors section, and updated badges |
| mkdocs.yml | Major configuration cleanup removing analytics, feedback systems, and unused features |
| docs/index.md | Updated homepage with new sponsor section and simplified feature grid |
| docs/assets/ | New logo and favicon assets with consistent branding |
| .github/workflows/ | Removed markdown linting workflow and simplified documentation deployment |
| docs/usage.md, docs/installation.md | Updated with improved link formatting and content organization |
Comments suppressed due to low confidence (1)
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Signed-off-by: GitHub <noreply@github.com>
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
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.
Description
Refreshes the project branding to be easier to maintain and cleaner.
General
Docs website
satchel.ryanluu.devtosatchel.luau.pagedomainGitHub Readme
Related Issues
Changes Made
This pull request focuses on streamlining documentation, improving workflows, and updating branding and sponsorship information for Satchel. The most significant changes include major updates to the documentation workflow, README reorganization, and removal of markdown linting configuration. Additionally, there are improvements to dev environment setup and branding consistency.
Documentation and Workflow Improvements:
.github/workflows/documentation.ymlto simplify deployment, improve caching, and switch to direct deployment usingmkdocs gh-deploy. Updated permissions and branch/path filters for more precise triggering..github/workflows/markdown.ymland deleted.markdownlint.json, discontinuing automated markdown linting in CI. [1] [2]Branding and Sponsorship Updates:
README.mdto use new badges, reorganized sections for clarity, added a sponsors section, and updated documentation links tosatchel.luau.page. [1] [2]satchel.ryanluu.devtosatchel.luau.pagefor consistent branding.Dev Environment and Miscellaneous:
.devcontainer/devcontainer.jsonto installmikealongsidemkdocs-materialfor documentation versioning support.vscode-markdownlintwithvscode-yamlfor YAML editing.docs/alternatives.md,docs/api-reference.md). [1] [2] [3] [4]Checklist
Additional Notes