Skip to content

docs: restructure coti privacy portal documentation#6

Open
plucena-coti wants to merge 1 commit intocoti-io:mainfrom
plucena-coti:docs/privacy-portal-restructure
Open

docs: restructure coti privacy portal documentation#6
plucena-coti wants to merge 1 commit intocoti-io:mainfrom
plucena-coti:docs/privacy-portal-restructure

Conversation

@plucena-coti
Copy link

Description

Restructure COTI Privacy Portal documentation to improve readability and maintainability.

Changes

  • Split coti-privacy-portal/README.md into focused guides:
    • User Guide (step-by-step instructions)
    • Troubleshooting (FAQ and support)
    • README (High-level overview & Key Features)
  • Rename Developer Guide to developer-guide.md (Developer Tutorial) and add content on transferAndCall.
  • Standardization:
    • Use max-height: 500px and width: auto for all images to prevent distortion.
    • Consistency with Bridge documentation formatting.
  • Update SUMMARY.md navigation.
  • Update Testnet contract addresses.

Related Issues

  • Addressing user feedback on documentation structure and clarity.

- Split  into focused guides:
    - User Guide (step-by-step instructions)
    - Troubleshooting (FAQ and support)
    - README (High-level overview)
- Rename Developer Guide to  (Developer Tutorial) and add content on .
- Standardization:
    - Use  and  for all images to prevent distortion.
    - Consistency with Bridge documentation formatting.
- Update  navigation.
- Update Testnet contract addresses.
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