Skip to content

Commit

Permalink
term: review usage of "engine"
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Jan 6, 2020
1 parent a964894 commit 6cbd929
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 16 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@ code.
# Documentation

This docs engine was built using [Node](https://nodejs.org/) +
[React](https://reactjs.org/),
[Next.js](https://nextjs.org/)/[React](https://reactjs.org/),
[react-markdown](https://github.com/rexxars/react-markdown), and integrates with
[Algolia](https://www.algolia.com/products/search/) to provide full text search.
The motivation for building it from scratch was the lack of flexibility
(customization, sidebar tuning) and ads in engines like readthedocs, docsify,
etc.
(customization, sidebar tuning) and ads in sites like readthedocs, docsify, etc.

Please feel free to use it for your own sites and
[reach out to us](https://dvc.org/support) if you have any questions.
Expand Down
6 changes: 3 additions & 3 deletions public/static/docs/changelog/0.35.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ improvements) we have done in the last few months:
progress bars for checkouts, better metrics output, and lots of smaller
things: ![|528x200](/static/img/0.35-metrics.gif)

- **⚡️Performance optimizations.** The most notable one is the migration from
using the plain JSON file to the embedded SQLLite engine to cache file and
directory checksums, another one is improved performance, stability and
- ⚡️ **Performance optimizations.** The most notable one is the migration from
using a plain JSON file to an (embedded) SQLLite instance, to cache file and
directory checksums. Another one is improved performance, stability and
general user experience for the commands that navigate tags or branches (all
the commands that include `--all-bracnhes`, `-a` or `--all-tags`, `-T`).

Expand Down
9 changes: 4 additions & 5 deletions public/static/docs/user-guide/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,10 @@ We will review your PR as soon as possible. Thank you for contributing!

## Development environment

It's highly recommendable to run the Node docs app locally to check
documentation changes before submitting them, and its very much needed in order
to make changes to the [Node](https://nodejs.org/) documentation engine itself
(rare). Source code files need to be properly formatted as well, which is also
ensured by the full setup below.
It's highly recommendable to run this web app locally to check documentation
changes before submitting them, and quite necessary when making changes to the
[Next.js](https://nexyjs.org/) engine itself (rare). Source code files need to
be properly formatted as well, which is also ensured by the full setup below.

Get the latest development version by
[forking](https://help.github.com/en/articles/fork-a-repo) and cloning the
Expand Down
8 changes: 4 additions & 4 deletions public/static/docs/user-guide/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ We welcome [contributions](/doc/user-guide/contributing/core) to

## Contributing Docs

We welcome any [contributions](/doc/user-guide/contributing/docs) to our
documentation repository, [dvc.org](https://github.com/iterative/dvc.org).
Contribution can be an update to the documentation or (rare) updating or fixing
the JS engine that we use to run the website.
We welcome any contributions to our documentation repository,
[dvc.org](https://github.com/iterative/dvc.org). Contributions can be updates to
the documentation content, or (rare) changes to the JS engine we use to run the
website.

- [Structure of the project](/doc/user-guide/contributing/docs#structure-of-the-project)

Expand Down
2 changes: 1 addition & 1 deletion server.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ app.prepare().then(() => {
res.end()
} else if (/^\/doc(\/.*)?$/.test(pathname)) {
/*
* Special Docs Engine handler
* Special docs engine handler
*/

// Force 404 response for any inexistent /doc item.
Expand Down

0 comments on commit 6cbd929

Please sign in to comment.