Skip to content

[FEATURE] burpference docs #20

@GangGreenTemperTatum

Description

@GangGreenTemperTatum

Problem Description

keeping every piece of information across READMEs is hard and not effective/scalable

Proposed Solution

burpference dedicated docs page

Alternative Solutions

NA

Use Case

a docs page linked to the repo

Additional Context

  • Introduction: Provide an overview of Burpference, highlighting its purpose as an open-source Burp Suite extension designed to capture in-scope HTTP requests and responses from Burp's proxy history and transmit them to a remote Large Language Model (LLM) API in JSON format.
  • Prerequisites: List necessary tools and software, such as Burp Suite and the Jython standalone JAR file, required for installation.
  • Installation Guide: self-explanatory whats needed for docs content
  • Configuration/Setup: Detailed explanation of configuration options, including how to set up and customize the configs directory to tailor burpference to specific needs.
  • Usage Instructions: Step-by-step guide on how to use Burpference within Burp Suite, including capturing HTTP traffic and sending data to the remote LLM API.
  • Features in Action: self-explanatory whats needed for docs content

Implementation Ideas

github pages, something similar and easy

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions