-
Notifications
You must be signed in to change notification settings - Fork 0
Update screenshots and organize docs directory #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a4ade7b
Initial plan
Copilot 22b957a
Initial plan for updating screenshots and organizing docs
Copilot d5a3a90
Update screenshots and organize docs directory
Copilot f05dca0
Add tsconfig.tsbuildinfo to .gitignore and remove from repo
Copilot 178bb01
Add mock data to screenshots and include Cloudflare captcha
Copilot 2da6f57
Remove captcha screenshot and document Turnstile support
Copilot 13cccff
Update docs to reference Turnstile captcha screenshot
Copilot 86d8b5e
add missing pic
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Documentation | ||
|
|
||
| This directory contains documentation assets for the Secrets Manager project. | ||
|
|
||
| ## Structure | ||
|
|
||
| ``` | ||
| docs/ | ||
| ├── README.md # This file | ||
| └── screenshots/ # Application screenshots for documentation | ||
| ├── 01-login.png # Login page | ||
| ├── 02-secrets-dashboard.png # Secrets management panel | ||
| ├── 03-secret-revealed.png # Secret value revealed | ||
| ├── 04-users-panel.png # User management panel | ||
| ├── 05-tokens-panel.png # API token management panel | ||
| ├── 06-permissions-panel.png # Permission configuration panel | ||
| └── 07-login-with-captcha.png # Login with Cloudflare Turnstile captcha | ||
| ``` | ||
|
|
||
| ## Screenshots | ||
|
|
||
| All screenshots are taken at 1280x720 resolution in PNG format and show the application's dark mode interface. | ||
|
|
||
| ### Adding New Screenshots | ||
|
|
||
| When updating screenshots: | ||
|
|
||
| 1. Start the server: `go run cmd/secretsserver/main.go --admin-password "admin123"` | ||
| 2. Navigate to `http://127.0.0.1:7770` | ||
| 3. Capture screenshots of each panel | ||
| 4. Save them with the naming convention: `##-descriptive-name.png` | ||
| 5. Update the main README.md to reference new screenshots | ||
|
|
||
| ### Screenshot Guidelines | ||
|
|
||
| - Use consistent viewport size (1280x720 or similar) | ||
| - Capture the full application interface including header and navigation | ||
| - Use realistic but safe example data (no real secrets) | ||
| - Ensure dark mode is enabled for consistency |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| node_modules/ | ||
| dist/ | ||
| yarn-error.log | ||
| tsconfig.tsbuildinfo |
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot why did u remove this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The tsconfig.tsbuildinfo is a TypeScript build artifact that gets regenerated on each build. It shouldn't be in version control as it's specific to each build environment. Added it to .gitignore in f05dca0.