projectdiscovery / projectdiscovery/docs

Introduce support for tool versions

Open
#56 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
MDX
Stars
28
Forks
62
Avg merge
1d 18h
Merged PRs (30d)
3

Description

Centralized docs seems to support only latest docs version of the tool, I'm not sure if support for versions should be introduced similarly to hashicorp:

Screenshot from 2024-05-22 14-26-05

Contributor guide

Open the contributing guide

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 reviewing the repository's documentation structure and the HashiCorp versioning example referenced in the issue. Define how versioned tool documentation should be represented and identify the affected documentation entry points; done means tools can expose versions rather than only latest.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
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.