orientechnologies / orientechnologies/orientdb-docs

3.0 - home page

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

Nobody has claimed this yet.

refactor
Dominant language
CSS
Stars
59
Forks
165
PR merge metrics
No merged PRs in 30d

Description

discussed internally already

there's a need to review and (re) aggregate in the home all the main resources by topic / role (e.g. dev, dba).

so far we have 4 different sections:

  • Quick Navigation
  • Operations
  • Quick References
  • Resources

but this is confusing.

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

Start by reviewing the documentation home page and the four sections named in the issue: Quick Navigation, Operations, Quick References, and Resources. Define an organization by topic or role, such as developer or DBA, and consider the work done when the main resources are easier to find and the current section structure is no longer confusing.

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
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.