Skip to content

Clean up documentation #736

@MarliesRikken

Description

@MarliesRikken

New Feature Request

Summary

Problem:
Documentation gets outdated as we are building new features and adjusting authority hierarchy.

Value:
Communicate current functionalities and features as clearly as possible. Help users use invite as self-service as possible.

Proposed Solution

Baseline UI should be as intuitive as possible. When we need to communicate complex concepts, then add extra info. Put info as close to the feature as possible in the UI.

<needs input and ideas from designer!>

  • Action: Describe the logic or flow change.
  • Design: [Link to Figma/Screenshots]
  • Impact: Does this affect existing APIs or UI components?

Developer Checklist

To be completed by the developer during implementation.

  • Add required changes and feature flags config files
  • Create and document database changes and migrations
  • Create and document API changes and migrations
  • check for backwards compatibility
  • Updated CHANGELOG and other documentation where needed

Testing and QA

Describe how to verify and test this change.

Test Environment and Setup

  1. Point to [URL/Branch]
  2. Use account with [Role/Permissions]

Test Checklist

  • Happy Path: Feature works as intended under normal conditions.
  • Edge Case: [Describe specific test item]
  • Validation: [Describe specific test item]
  • UI/UX: Verified layout across screen sizes.

Extra Information

Add any other context, related issues, or technical notes here.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    New

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions