wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-23 15:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

[hygiene] [doc] consolidate docs in root readme

Browse source 
Move /docs/ui/README.md into /README.md. This fixes an issue where the
precommit script dirties the working directory on every commit (it
deletes docs/ui/README.md, which can be confusing) and makes the root
readme the single source of documentation.

Change-Id: Id99ca09b738a6fd3299f1acb4f238902461cdd95
This commit is contained in:
Stephen Niedzielski 2020-01-14 08:53:13 -07:00
parent f9473f1830
commit 7d86f0d732
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -78,6 +78,10 @@ separated from the main package.json until CI upgrades from Node 6. NVM can be u
manage multiple Node versions to run the Storybook app (`cd .storybook && nvm use`).
See the .storybook/README.md for details.
## Building the documentation
Execute `npm -s run doc`.
## Terminology
* Footnote - What the Cite extension shows at the bottom of the page.

2
docs/ui/README.md
View file

@ -1,2 +0,0 @@
Run `npm run doc`!