18191829625
73%

Ran 02 Oct 2025 12:44PM UTC

Jobs 1

Files 78

Run time 1min

Badge

Embed ▾

Committed 02 Oct 2025 11:36AM UTC coverage: 72.929% (-0.3%) from 73.193%

Build # 18191829625

Build Type

push

github

Committed by

web-flow

Commit Message

feat(docs): Add docs site (#345)

* feat(docs): initialize Hugo documentation site

This commit introduces a documentation website for ptcpdump, built with Hugo and the Docsy theme.

- Sets up the basic Hugo site structure in the /docs directory.
- Configures the site with a landing page, navigation, and i18n support for English and Chinese.
- Populates the site with initial content, including installation, usage, and about pages.
- Adds the Docsy theme as a git submodule and resolves all build dependencies.

* docs: expand guides and add localized content

* docs: add comprehensive backend and example guides

This commit significantly expands the documentation site by adding two major sections:

- A "Backend Guide" that details the different eBPF backends supported by ptcpdump, including their trade-offs and example commands.
- A "Scenario Playbook" that provides a rich library of real-world usage examples, mirroring the projects automated tests for scenarios like container tracing, network namespace inspection, and file rotation.

Additionally, this commit refactors the content structure, updates existing guides, and adds necessary dependencies for the Hugo theme. Both English and Chinese localizations are included.

* ci: add ci for github pages

* test deploy gh pages

* fix missing install hugo

* fix layout

* remove debug

Run Details

4973 of 6819 relevant lines covered (72.93%)

0.81 hits per line

Uncovered Existing Lines

Lines	Coverage	∆	File
2	61.09	-0.45%	bpf/event.go
5	72.0	-20.0%	internal/utils/c.go
16	50.0	-34.78%	internal/consumer/keylog.go

Jobs

ID	Job ID	Ran	Files	Coverage
1	18191829625.1	02 Oct 2025 12:44PM UTC	78	72.93	GitHub Action Run

mozillazg / ptcpdump / 18191829625
73%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 18191829625

mozillazg / ptcpdump / 18191829625 73%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 18191829625

mozillazg / ptcpdump / 18191829625
73%

README BADGES
x