Docs refactor and updates - #187
Merged
Merged
Conversation
terranosaurus
left a comment
terranosaurus
left a comment
Contributor
There was a problem hiding this comment.
- Landing page makes sense
- Get started tile: Should we call out GitHub app so explicitly? On the linked Installation page do we need to mention the GH action or how to rig up for other SCMs like Bitbucket?
- This has bugged me for awhile but I never got back to it: the Pixee logo links to our marketing website but in the user platform it’s how a user returns to the landing page (dashboard). Here in Docs, there’s no way to get back to the landing page other than via the back button because of this. Many other well-known technical docs sites don’t link to their respective marketing sites in this way - see Stripe, GitHub, GitLab, Docker, etc. That being said, they usually have a DOCS label with the logo, which I can easily create. Personally I feel our Pixee logo should link back to the docs landing page.
- Open Pixee page - agree with Arshan’s notes re: GH-centric and overall story right now, but otherwise was going to suggest we at least rename it - Open Pixee was confusing to me at first. I mean it doesn’t not make sense, but feels awkward somehow IMO. Could just say simply “Open source”
- User guide - I feel like this page should mirror and have basic coverage of everything we call out initially in the Introduction, so should have headers and blurbs for Continuous improvement, PR improvement, and Triage. Can follow up with more ideas for that separately.
- I think the order of side nav should be updated to:
- Intro
- Install
- User guide (could also see the case for Preferences first)
- Preferences
- Tool fixes
- Core codemods
- Open source
- FAQs
- Release notes
- Sentence case updates - I’ll do that separately after this gets merged
nahsra
approved these changes
Aug 22, 2024
fixed typo
ADO to Azure DevOps
on-premises to self-hosted
on prem to self hosted
sip49
reviewed
Aug 22, 2024
sip49
left a comment
sip49
left a comment
Member
There was a problem hiding this comment.
Left a few comments throughout and also made some commits inline.
Member
There was a problem hiding this comment.
I generally agree with the "Pixee" vs "pixeebot" usage. However in this file, we are specifically referring to the Github app in a few places, so I assume those should be "Pixeebot" not Pixee, right?
This was referenced Sep 4, 2026
dunningdan
added a commit
that referenced
this pull request
Sep 7, 2026
#302 cleared 42 of 51 Dependabot alerts by refreshing yarn.lock, but 9 survive because re-resolution provably cannot reach them - their parents either pin an exact version or cap below the patched release: minimatch parent pins 9.0.3 exactly -> 9.0.9 yaml parent pins 2.8.1 exactly -> 2.9.0 serialize-javascript parent caps at ^6.0.0 -> 7.1.1 uuid parent caps at ^8.3.2 -> 11.1.1 qs parent caps at ~6.15.1 -> 6.16.0 yarn resolutions are the only lever here, following the existing `got` entry. This clears 9 of the 11 currently open alerts. qs is the newest of these: GHSA for it was published Sep 2 and GitHub raised alerts #197/#198 three minutes after #302 merged, against the freshly refreshed lockfile. `~6.15.1` excludes 6.16.0, so no future lockFileMaintenance pass would have fixed it either. Remaining open after this: #186/#187 image-size, which has no patched version published upstream. Reached via @docusaurus/mdx-loader at build time only; tracked for risk acceptance rather than code change. Verified on Node 24.20.0: yarn build passes (59 documents) and the dev server serves HTTP 200, which exercises sockjs -> uuid@11, the one bump here that crosses major versions and that a production build would not otherwise cover. Also refreshes the lockFileMaintenance description - it still told the reader to restore a weekly schedule, which is no longer the intent. No behavior change; schedule stays "at any time". Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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
4 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.
This PR refactors and updates our docs to put a greater emphasis on triage and tool remediation. It is intended as a starting point for additional docs update. The docs are intended to answer the following questions of a potential customer:
Probably some additional cross-links between sections would be useful.
I did not attempt to improve the styling at all; this might be worth revisiting at a later date.