IQSS / IQSS/dataverse

Feature Request/Idea: switching from Sphinx docs to using Docusaurus

Open
#8,905 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: User Guide Type: Suggestion
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request
What are thoughts on switching from Sphinx docs to using Docusaurus for the Dataverse documentation?

The search feature in Sphinx is no good and does not handle quoted 'specific' text searches very well, if at all. For instance, if I search on "categorical labels" it gives me top results on items that are not specific to these two words. Docusaurus has built-in support for Algolia document search, which is free to Open Source projects and works extremely well on specific text searches. This makes searching things in the documents much easier.

I would be willing to work on transiting the docs to Docusaurus if there is interest in it. Anyway, just something to think about that might improve the Dataverse documentation.

Contributor guide

Open the contributing guide

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 existing Sphinx documentation setup and the Docusaurus and Algolia documentation linked in the issue. Determine whether the project wants a migration and define the documentation scope, search requirements, and acceptance criteria before implementation; the issue does not name files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.