Refresh documents (README.md and our site) #676
Merged
Conversation
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
Moved the white-box styling from a separate CSS file into the Layout.astro component and applied it via a class. Updated all pages to use the new class and removed the now-unnecessary white-box.css. Improved button styling on the index page and added a custom 404.astro page. Also made minor formatting and code style improvements.
Revised the macOS installation page to use a step-by-step ordered list and clarified instructions. Added a 'Usage' step to the Windows installation guide, directing users to the usage page for further help.
Replaced 'obs-backgroundremoval-git' with 'obs-backgroundremoval' in Arch instructions and removed redundant text. Improved Flatpak instructions with a clearer step-by-step format and updated headings for better clarity.
Added an 'All set!' completion message to the Arch, Flatpak, macOS, and Windows installation pages for consistency. The usage page was rewritten for clarity, now using a step-by-step ordered list and improved tips for best results. Minor formatting and accessibility improvements were also made.
Added a 'View on GitHub' link to the index page and updated all external links to include rel="noopener" for improved security. Also removed the unused GitHub SVG asset.
Introduced demo.gif and obs-backgroundremoval-icon.jpg assets and updated index.astro to display the plugin icon and a demo image on the homepage. Improved layout by grouping the icon and title, and reorganized the download buttons for better clarity.
umireon
changed the title
Introduces a reusable MarkdownLayout.astro component for consistent page layouts and adds a detailed guide (ubuntu.md) for developing OBS Background Removal on Ubuntu, including setup, build, packaging, and linting instructions.
Replaces the Arch Linux installation guide from an Astro file to Markdown for consistency. Adds a new developer resources section with guides for Windows and macOS, updates layouts to support navigation, and links to developer resources from the home page.
Added a new uninstall.md page with instructions for removing the plugin on Windows, macOS, and Ubuntu. Updated download and usage links throughout the site to consistently use trailing slashes in URLs. Added a link to the uninstall instructions on the index page.
Replaced UNINSTALL.md and development guides for macOS, Ubuntu, and Windows in the docs directory with symlinks pointing to their new locations under pages/src/pages. This helps maintain a single source of truth for documentation.
Deleted symlinks in the docs/ directory that pointed to markdown files in pages/src/pages/. This cleanup may be part of a documentation restructuring or migration.
sobalap
pushed a commit
to sobalap/obs-backgroundremoval
that referenced
this pull request
Jan 7, 2026
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.
The documentation is updated to reflect current situation.
README.md was changed for users to find download links easily.
GPU support is not verified now so commented out.
Building instructions are outdated so removed.