equinor / equinor/everest-tutorials

Create a README.md describing the project

Open
#28 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Assembly
Stars
3
Forks
2
Avg merge
1h 23m
Merged PRs (30d)
1

Description

The repository is missing the README.md file to describe the project.

If relevant this can then be added to the main sphinx documentation, using a direct link to the file, similarly to what's done for the [changelog.rst](https://github.com/equinor/everest-tutorials/blob/4a9d5a72a457614456293dcaba892d3bb2ca6de8/docs/source/development/changelog.rst).

Contributor guide

Open the contributing guide

Research direction

Review the existing Sphinx documentation and docs/source/development/changelog.rst for the project's current documentation style and structure. Create README.md with a useful project description, and, if appropriate, add a direct link from the main Sphinx documentation; done means the README exists and the link is correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.