nmap / nmap/npcap

Improve Docbook and reference guide titles and breadcumb/rendering

Open
#592 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
3.6k
Forks
592
PR merge metrics
No merged PRs in 30d

Description

@dmiller-nmap and I were just discussing some pages on the new site like https://npcap.com/guide/index.html which currently repeats "Npcap: Nmap Project's packet sniffing library for Windows" 4 times near the top. Two in the purple bar and then once centered and bolded below that, and then in large bold text below that. And then it comes to the table of contents. Other Docbook pages we host have similar issues, though usually not quite that bad (and for some these breadcrumbs are beneficial). So were were thinking of doing something like:

  • Rename the Npcap guide something like "Npcap Reference Guide" rather than "Npcap: Nmap Project's packet sniffing library for Windows" so references to the title aren't so verbose.
  • Dan is working on some cool breadcrumbs navigation for libpcap API docs which could be expanded to our other Docbook-generated pages: https://npcap.com/guide/wpcap/pcap_strerror.html.
  • Dan was talking about removing the document name from the purple titlebar and possibly document title, especially if we have new breadcrumb navigation providing the context.

These approaches aren't set in stone. Dan may come up with different/better ways to handle it. But we wanted to add this ticket so we don't forget about it.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the repeated title and breadcrumb rendering on https://npcap.com/guide/index.html with the libpcap example at https://npcap.com/guide/wpcap/pcap_strerror.html. Review the DocBook-generated pages and existing breadcrumb work, then define consistent title and navigation behavior across the affected guides.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.