projectdiscovery / projectdiscovery/docs
Integrate Featurebase Button into Documentation Site
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 28
- Forks
- 62
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 3
Description
Objective: Add a button to the documentation site that links to Featurebase (feedback.projectdiscovery.io) to facilitate user feedback.
Tasks:
-
Design Button:
- Create a visually appealing button that matches the site's design.
- Ensure the button is clearly labeled (e.g., "Give Feedback" or "Submit Feedback").
-
Determine Placement:
- Decide on the optimal placement for the button on the documentation site (e.g., header, footer, or sidebar).
-
Implement Button:
- Add the button to the chosen location on the documentation site.
- Ensure the button links directly to Featurebase.
-
Test Functionality:
- Verify that the button is visible and functional on all pages of the documentation site.
- Ensure the link directs users to the correct Featurebase page.
Acceptance Criteria:
- The feedback button is designed and integrated into the documentation site.
- The button is visible, functional, and correctly links to Featurebase.
- The button placement is intuitive and does not disrupt the user experience.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the shared layout or navigation entry point used across the documentation site, then review its existing styling and links. Add a clearly labeled feedback button linking to https://feedback.projectdiscovery.io, and verify that it appears and works on all documentation pages without disrupting the layout.
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
- 45/100