Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add probe-engine to sidebar #5

Merged
merged 12 commits into from
Jul 5, 2024
Merged

feat: add probe-engine to sidebar #5

merged 12 commits into from
Jul 5, 2024

Conversation

DecFox
Copy link
Contributor

@DecFox DecFox commented Jul 4, 2024

This diff adds probe-engine to the sidebar. We added the docs to docs.ooni.org here: ooni/probe-cli#1634

Copy link

vercel bot commented Jul 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 5, 2024 2:58pm

astro.config.mjs Outdated
{
label: "Probe Engine",
autogenerate: { directory: "probe-engine" },
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's put it above Legacy Backend. Otherwise LGTM

@hellais
Copy link
Member

hellais commented Jul 4, 2024

I had to apply a few fixes to the master branch of probe-cli to get it to write the docs properly, but it's now good to go.

It's still failing to build due to it missing the support for the languages. I will install this plugin that should fix it: https://expressive-code.com/installation/

@hellais
Copy link
Member

hellais commented Jul 4, 2024

Syntax highlighting is not working so well, but I think it's good enough.

Also some pages look empty or incomplete. You might want to look into that before we merge it.

@hellais
Copy link
Member

hellais commented Jul 4, 2024

It runs locally, but it's failing on vercel. Probably worth debugging tomorrow. @DecFox

error was:

Cannot find module @rollup/rollup-linux-x64-gnu. npm has a bug related to optional dependencies (npm/cli#4828). Please try `npm i` again after removing both package-lock.json and node_modules directory
@hellais
Copy link
Member

hellais commented Jul 5, 2024

This looks great, the only nitpick is that these two side-bars aren't lighting up. It's probably and issue in how the autogenerate thing is working. It's also probably wise to avoid using 00- for two items to ensure proper sorting of the items.

The side-bars not working are:

I suggest we merge this and document this as future work as it's still fully functional

Copy link
Member

@hellais hellais left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's land it and document as an issue what I said in: #5 (comment)

@DecFox
Copy link
Contributor Author

DecFox commented Jul 5, 2024

Thanks! The bug has been documented here: #6. I am going to go ahead and merge.

@DecFox DecFox merged commit 0c9879c into main Jul 5, 2024
2 checks passed
@DecFox DecFox deleted the probe-engine branch July 5, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants