orientechnologies / orientechnologies/orientdb-docs
Latest version of documentation is hard to find
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 59
- Forks
- 165
- PR merge metrics
- No merged PRs in 30d
Description
There are several issues that make the latest documetnation of OrientDB hard to find:
- Many links to OrientDB documentation link to https://orientdb.org/docs/, https://orientdb.com/docs/3.0.x/ or https://orientdb.com/docs/3.1.x/ which are all out of date.
- None of the out of date documentation versions have any warning that they are out of date or a link to the latest documentation.
- There appear to be two different copies of 3.2.x documentation: https://orientdb.org/docs/3.2.x/ and https://orientdb.com/docs/3.2.x/. There is no clear indication which version is correct or if the content is the same with only stylistic changes.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by comparing the documentation URLs listed in the issue and tracing where those links and version notices are maintained; done means the current documentation is clearly discoverable, older versions identify themselves as outdated, and the two 3.2.x copies have an explicit relationship or resolution.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100