HarperFast / HarperFast/documentation

Add more Operations API examples

Open
#373 0 comments 0 reactions 0 assignees View on GitHub
content
Dominant language
MDX
Stars
9
Forks
9
Avg merge
2d 12h
Merged PRs (30d)
32

Description

### Request Type

Code examples

### What needs to be documented?

Our operations API is really important but lacks examples. We should add more realistic examples for using operations API.

Moreover, the operations API docs is very reference heavy right now. As part of the larger doc rewrites, we want to have a narrative guide like operations overview that will be full of examples and then the reference can just have specific details.

### Where should this be documented?

Operations sections.

### Why is this needed?

_No response_

### Existing information

_No response_

### Priority/Impact

High - critical for user success

### Are you planning to fix this issue?

No, just reporting the issue

### First-time contributor support

- [ ] I'm new to contributing and would appreciate guidance on the process
- [ ] I'd like help understanding the project structure
- [ ] I need assistance with setting up the development environment
- [ ] I'm comfortable contributing but new to this project specifically

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.