Skip to content

directory: expand service README#6701

Open
Narasimha-sc wants to merge 5 commits intomasterfrom
nd/directory-doc
Open

directory: expand service README#6701
Narasimha-sc wants to merge 5 commits intomasterfrom
nd/directory-doc

Conversation

@Narasimha-sc
Copy link
Copy Markdown
Collaborator

Summary

  • Add build prerequisites (system packages, GHC 9.6.3 / Cabal 3.10.2+) and cabal build / cabal run instructions
  • Document running the bot: bootstrap flow to discover contact ID, minimal invocation, and full CLI flag reference
  • Document self-hosting the directory website via --web-folder + static server
  • Add full bot command reference: search/browse, group registration, user group management (list, role, filter, link, delete), admin commands, super-user commands, and group lifecycle diagram

Test plan

  • README renders correctly on GitHub
  • All commands and flags match current simplex-directory-service implementation

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Narasimha-sc and others added 3 commits March 23, 2026 21:22
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Invited by owner
PendingConfirmation ──(/confirm)──▶ Proposed
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

PendingConfirmation state only happens in case on duplicate name.

┌───────────┴───────────┐
▼ ▼
Active (profile change
(listed) → re-enters pending)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

On "re-enters pending" - it's not as simple, and depends on whether correct link remained in the profile.

#### View or set default join role

```
/role <ID>[:<name>] [member|observer]
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

it's unclear here and below when name must be used


Shows all groups you have registered with their current status.

#### Confirm duplicate name
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

unclear why it exists

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.

2 participants