projectdiscovery / projectdiscovery/docs

Add Quick "GitHub" Link to Top of Open Source Documentation Overview Pages

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

Nobody has claimed this yet.

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

Description

Objective: Add a quick link to GitHub at the top of each tool's overview documentation page to facilitate easy access to the project's GitHub repository.

Tasks:

  1. Design GitHub Link:

    • Create a button or link that is clearly labeled (e.g., "View on GitHub").
    • Ensure the design matches the overall style of the documentation site.
  2. Determine Placement:

    • Decide on the optimal placement for the GitHub link at the top of each tool's overview page.
  3. Implement Link:

    • Add the GitHub link to the top of each tool's overview documentation page.
    • Ensure the link directs users to the corresponding GitHub repository for each tool.
  4. Test Functionality:

    • Verify that the GitHub link is visible and functional on all overview pages.
    • Ensure the link directs users to the correct GitHub repository for each tool.

Acceptance Criteria:

  • The GitHub link is designed and integrated into the top of each tool's overview documentation page.
  • The link is visible, functional, and correctly directs users to the corresponding GitHub repository.
  • The link placement is intuitive and enhances the user experience.

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

The issue names no files or tests. Start by locating the tool overview documentation pages and their corresponding repository links, then establish a consistent top-of-page placement; done means every overview page shows a visible, working GitHub link to the correct repository.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.