Documentation

Open Beginner friendly
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
documentation

Research direction

Start by reviewing the repository structure and the existing usage of its RDF mapping classes, then consult the rdfjs/wrapper context linked in the issue. Add a brief overview explaining the relationship to rdfjs/wrapper and include example usage; the documentation is done when a newcomer can understand what the objects provide and how to use them.

Written by the indexing model from the issue text.

Description

We need to add some documentation to this repository with a brief overview that this provides objects to be used with https://github.com/rdfjs/wrapper and an overview of how to use them / example usage.

Note that full documentation for https://github.com/rdfjs/wrapper is currently being developed in https://github.com/rdfjs/wrapper/pull/31.

Dominant language
TypeScript
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

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.

More from solid/object

All issues in solid/object

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.