projectdiscovery / projectdiscovery/docs

Revise Admin/Settings Guide

Open
#81 0 comments 1 reaction 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: Revise the Admin/Settings Guide to ensure it is up-to-date and accurately reflects the latest features and improvements. This will likely require another iteration to update details once UX improvements from the linked issues are implemented.

Current Content: Admin/Settings Guide

Related UX Improvement Issues:

Tasks:
  1. Review Current Guide:

    • Conduct a thorough review of the existing Admin/Settings Guide.
    • Identify any outdated or unclear information.
  2. Update Content:

    • Revise sections to reflect the latest features and settings.
    • Ensure all screenshots and examples are current and accurate.
    • Improve clarity and organization of the guide to enhance user understanding.
  3. Monitor UX Improvement Issues:

  4. Review and Approve:

    • Share the revised guide with relevant stakeholders for review and approval.
    • Incorporate any feedback and make necessary revisions.
  5. Publish Updates:

    • Update the Admin/Settings Guide with the revised content.
    • Ensure the changes are live and verify that the updated information is displayed correctly.
  6. Plan for Next Iteration:

    • Schedule a follow-up review to update the guide based on the UX improvements from the linked issues.

Acceptance Criteria:

  • The Admin/Settings Guide is up-to-date and accurately reflects the latest features and settings.
  • The guide is clear, well-organized, and easy to understand.
  • The updated guide has been reviewed and approved by relevant stakeholders.
  • The changes are live on the documentation site and display correctly.
  • A follow-up plan is in place to update the guide after the UX improvements are implemented.

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 with the Admin/Settings Guide linked in the issue and compare its current sections, screenshots, and examples against the latest product behavior. Review Platform UI issues #602 and #603 before deciding what can be updated now. Done means the guide is accurate, clear, published, reviewed, and has a follow-up plan for the UX changes.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.