Commit Graph

16 Commits (e8345da6239827463afbef6c13826c2d858a12c1)

Author SHA1 Message Date
Naomi Carrigan f9d148890f
docs: general cleanup and maintenance (#50473)
Co-authored-by: Sem Bauke <semboot699@gmail.com>
2023-05-26 16:19:27 +05:30
Kolade Chris d614c4173f
docs: update pnpm commands, fix typos and grammar (#49990
* fix: improving the docs

* fix: did some more typos and gramos fixes

* fix: fixed typographical and grammatical errors, capitalized headings, made adjustments to the directories to run pnpm run create-project.

* Implemented Shaun's suggested changes

* Removed duplicate lines from my end

* Fixed a few "open-source" and "open source" confusion
2023-04-10 15:15:26 +05:30
Oliver Eyton-Williams d7848ae01a
feat: migrate to pnpm for better workspace DX (#49293)
* feat: npm -> pnpm 

This resolves the issues with the gatsby client (gatsby-plugin-pnpm
deals with the fact that gatsby is relying on its own dependencies
being de-duped)
and challenge-editor (which doesn't seem to want to automatically install
codemirror and needed its own eslint config)

* fix: correct mocha path for curriculum tests

* fix: use select workspace with -F not -w

* fix: reorganise packages and restrict hoisting

pnpm works best if the workspaces keep their own dependencies, since
dependencies are not flattened and then what node resolves from a
require is predictable.

@types seem to be a special case and more care is required to prevent
them getting smushed together in the root (hence the .npmrc)

* fix: add types for tools + root

* fix: decouple challenge-auditor from client

* fix: add ui-components types

* fix(client): use the latest types for react 16

* fix: prettify

* fix: prettierignore pnpm-lock

* fix: relax hoisting

Turns out pnpm works just fine with types. I don't know what was going
wrong before, but there are no-longer any type conflicts.

* fix: add @redux-saga/core to fix eslint issue

It seems to only be redux-saga that import/named can't cope with, so it
is probably okay to work around this one.

* chore: add chai to tools/scripts/build

* fix: add store to root for cypress

* fix: allow cypress to download binaries

If we want to keep preventing cypress from downloading binaries, we can
figure out a workaround, but I'm allowing it to ease the transition to
pnpm.

My guess about why this is happening is that npm triggers Cypress's
postinstall script, but pnpm does not (because pnpm install only
installs if necessary, perferring to link)

* chore: re-enable pre/post scripts

* fix: update build scripts for client

Co-authored-by: Shaun Hamilton <shauhami020@gmail.com>

* chore: update engines to use pnpm


* fix: enable choice of (super)block for tests

Only 'nix machines for now.

* chore: pin pnpm to version 7

* chore: remove last npms

Except web + curriculum-server. I'll update them when I start work on
them again.

* fix: lockfile check to catch any package-locks

* fix(action): install pnpm for upcoming tests

* chore: add nodemon to new api

Co-authored-by: Shaun Hamilton <shauhami020@gmail.com>
2023-03-02 18:17:44 +00:00
Allison J Harper b19147fc8b
fix(docs): add instructions for including files in sidebar (#48624)
* Update how-to-work-on-the-docs-theme.md

* Update docs/how-to-work-on-the-docs-theme.md

Co-authored-by: Mrugesh Mohapatra <1884376+raisedadead@users.noreply.github.com>
2022-11-30 19:46:59 +05:30
Mrugesh Mohapatra af466c9406
docs: updates for environment and other nits (#48477)
* docs: updates for environment and other nits

* docs: remove the button and link to guide

* fix: title case entry
2022-11-11 15:31:32 +02:00
Muhammed Mustafa 70b97f6f5a
docs: reduce abstraction and make it easier to read (#48377)
* docs: reduce abstraction and make it easier to read

* Clearer text, for better readiablity

Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>

* fix old file name and make things clearer

* clear stray string, and improve the readiblty

Co-authored-by:  SemBauke <semboot699@gmail.com>

* Link the documentation to sidebar

* Add issue to trouble shooting and simplify npm command

* feat: add issue about 404 page

* Revert removal of optional scope

* fix grammar issues and make it more concise

Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>

* rename contribution file, and move rebase advice

Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>
Co-authored-by: SemBauke <semboot699@gmail.com>
Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>
2022-11-11 12:49:40 +05:30
Lucas Vance 6a77597331
fix(docs): Update docs for Docsify port 3400 (#47671)
Update how-to-work-on-the-docs-theme.md
2022-09-29 22:01:31 +02:00
Ilenia 2ed0720b6e
docs: remove duplicated commands (#46800)
docs: fix commands
2022-07-08 10:30:38 +00:00
Kiran Kumar eac86f3f0f
docs: Grammar and typos corrected (#46599) 2022-06-21 19:49:26 +05:30
sidemt be5fe6d4b7
docs(docs, i18n): add instruction for internal links (#46509)
* docs: add instruction for internal links

* docs: add examples in HTML
2022-06-15 17:51:04 +02:00
ozayman 1525963577
fix: grammar on doc theme documentation (#45854) 2022-05-04 00:58:38 +07:00
Nicholas Carrigan (he/him) e5b43edf84
docs: master -> main (#40857)
Updates the docs to reflect the change from `master` to `main` as our
primary branch.

Signed-off-by: nhcarrigan <nhcarrigan@gmail.com>
2021-02-01 19:55:24 +05:30
Mrugesh Mohapatra c064bf0022 fix(docs): local server config, run alongside fCC 2020-10-04 07:54:30 +05:30
Mrugesh Mohapatra b16c0641bf
docs: update and simplify all documentation (#39686)
Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
2020-09-26 17:51:23 +05:30
Ashik Paul 47c457e548
Fixed some minor typos (#39225)
* Fixed some minor typos

* Adding few more changes

Adding changes suggested by @RandellDawson.

Thank you @RandellDawson

Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com>

Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com>
2020-07-11 20:06:37 -07:00
Mrugesh Mohapatra 0541506488
docs: add/update documentation (#38590) 2020-04-21 02:16:46 +05:30