OpenConext / OpenConext/OpenConext-Invite

Clean up documentation

Open
#736 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs refinement
Dominant language
Java
Stars
6
Forks
7
Avg merge
12h 24m
Merged PRs (30d)
11

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points and requests designer input. First clarify the documentation scope and identify the invite and authority-hierarchy materials affected; done means the current functionality and self-service invite guidance are documented clearly, with verification steps defined.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.