Skip to content

Docs improvments - typos, style edition, Mysql/postgreSQL homogeneity - #2313

Merged
s3inlc merged 2 commits into
masterfrom
doc-improvements
Jul 31, 2026
Merged

Docs improvments - typos, style edition, Mysql/postgreSQL homogeneity#2313
s3inlc merged 2 commits into
masterfrom
doc-improvements

Conversation

@coiseiw

@coiseiw coiseiw commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator
  • Remove internal draft notes that were published on the docs site
  • Change the UI port: web UI on 4200, backend/API/legacy UI on 8080
  • Split the offline installation into MySQL and PostgreSQL subsections and clarify docker-compose.yml naming
  • Align the FAQ upgrade answer with the update guide;
  • drop tips.md (duplicate of a FAQ entry)
  • mkdocs.yml: fix broken edit links, move fonts in the right place, remove unused Redoc leftovers;
  • add worked Wordlist/Rule bulk example

…e install

- Remove internal draft notes that were published on the docs site
  (agents, tasks, hashlist, crackers_binary, settings, user-settings)
- Document verified behavior: cracking position, Download Report
  (legacy UI only), agent binary fields and update tracks
- Restore the import-from-server upload method (reintroduced in the
  new frontend) in files.md and hashlist.md
- Fix the UI port story: web UI on 4200, backend/API/legacy UI on 8080
- Split the offline installation into MySQL and PostgreSQL subsections
  and clarify docker-compose.yml naming and the 8081 download server
- Align the FAQ upgrade answer with the update guide; drop tips.md
  (verbatim duplicate of a FAQ entry)
- mkdocs.yml: fix broken edit links, apply intended fonts, remove
  unused Redoc leftovers; add worked Wordlist/Rule bulk example
- Copy-edit pass over all pages; turn TODO notes into a staged worklist

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coiseiw
coiseiw requested review from ObsidianOracle and s3inlc July 7, 2026 13:23
Comment thread doc/installation_guidelines/basic_install.md
Comment thread doc/user_manual/basic_workflow.md Outdated
Comment thread doc/user_manual/hashlist.md Outdated
Comment thread doc/user_manual/hashlist.md Outdated
Comment thread doc/user_manual/hashlist.md Outdated

@ObsidianOracle ObsidianOracle left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with what has been changed.

@s3inlc
s3inlc self-requested a review July 31, 2026 07:48
@s3inlc
s3inlc merged commit 3b6b28b into master Jul 31, 2026
20 checks passed
@s3inlc
s3inlc deleted the doc-improvements branch July 31, 2026 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants