chore: misc fixes - #57
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR applies a set of small documentation/build maintenance tweaks for the OpenSourceBrain Documentation site, including CI simplification and updated social/link references.
Changes:
- Disable Jupyter Book notebook execution in
source/_config.ymland remove redundant CI steps that were editing that setting during workflows. - Update social references from Twitter to X in user-facing docs and README.
- Expand local build/publish instructions around
build-helper.shand make a small help-text fix in the script.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
source/OSBv1/links.yml |
Removes an unused links YAML file. |
source/General/Contacts.md |
Updates “Twitter” wording to “X” for the follow section. |
source/_config.yml |
Disables notebook execution by default and removes an unused analytics placeholder. |
README.md |
Updates the follow badge and fixes the CONTRIBUTING link to use main. |
CONTRIBUTING.md |
Adds build-helper usage documentation and refines publishing instructions. |
build-helper.sh |
Fixes the -c help text to reference the correct venv directory variable. |
.github/workflows/publish.yml |
Removes the step that patched _config.yml via sed. |
.github/workflows/prs.yaml |
Removes the step that patched _config.yml via sed. |
Suppressed comments (1)
CONTRIBUTING.md:51
- This sentence is wrapped across multiple lines, which conflicts with the guideline at the top of this file to start each sentence on its own line (lines 4–5). Consider keeping the whole sentence on a single line.
The build helper script will automatically use [uv](https://github.com/astral-sh/uv)
to create the virtual environment if it is available on your system, falling back
to `python3 -m venv` otherwise.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+16
to
+17
| execute: | ||
| execute_notebooks: auto | ||
| execute_notebooks: off |
Contributor
There was a problem hiding this comment.
Fixed in the latest commit — execute_notebooks: off is now quoted as 'off'.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: sanjayankur31 <102575+sanjayankur31@users.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.
No description provided.