frontarm/navi-website

The documentation website for Navi

navi-docs

This repository contains the documentation website for Navi.

You can view the documentation online at Frontend Armory -- this repository is primarily intended for use by contributors.

Getting Started

Fork and clone the repository, then install the dependencies and peer depedencies with yarn. Currently, you'll manually need to switch peerDependencies to devDependencies in package.json to do this, as yarn does not include a tool to install peer dependencies.

Once both the peer dependencies and dependencies have been installed, you're ready to start the dev server.

yarn install
yarn start

The site's pages are specified in <src/pages/index.html>. You can add, remove or edit content from here.

Note: the reason that dependencies aren't placed in devDependencies is that this package is used as part of a monorepo, and adding the peer deps to devDependencies causes conflicts with other packages.

Changes from vanilla create-react-app

This repository is based on create-react-app, but eject was run in order to enable two features:

• __filename support, which is used to add the Edit this page on GitHub links on each page.
• .mdx support, which makes it possible to mount the entire site within Frontend Armory.

If it becomes possible to use these features without ejecting, the documentation will be moved back to an unejected create-react-app.

navi-website's Issues

Unexpectedly access to outdated content

Reproduce:

• Google search react navi usehistory
• Go to this link https://frontarm.com/navi/en/reference/history/ , and wait until page to be fully loaded.

Then I got a completely outdated verson of this document. It is kept across navigation.

Search

The documentation website needs search functionality, probably built using Algolia.

The UI should be relatively easy - just put a search box at the top of the sidebar (below the brand).

As for building an index, it should be possible given that Navi lets us easily build a site map, and given that the site is set up to allow Demoboards to be rendered as text by changing context. It's just a matter of actually implementing it.

Translation - 日本語

If you'd like to translate any of the following pages, please make sure nobody else is already working on it by leaving a comment :-)

To make translate a page:

1. In Add a document.ja.md file next to the page's document.en.md file.
2. Update src/content/index.js with title and description.

Some English pages are missing code samples, but the text for all pages is ready to be translated. Code samples can be added later.

Top level

• Start Here
• Motivation
• Comparison With Similar Tools
• Creating A New App

Guides

• Getting Started
• URL Parameters
• Requests, Routes and Matchers
• Nested Routes and Views
• Programmatic Navigation
• Routing Context
• Authenticated Routes
• Static Rendering
• Setting meta and title

API Reference

• Components and Hooks
• history
• Matchers
• navigation
• router
• Types

Usage with...

• react-router
• react-helmet

the project can't started with an error