Unified doc's name & update docs #1069
Conversation
PurityFan
commented
May 12, 2019
•
PurityFan
commented
- Fix issue Unable to open webUI link #1063
- Unified doc's name:
- For .md file, use the uppercase for initial letters, no spacers. For example BuiltinTuners.md, BatchTuner.md
- For .rst file, use lowercase for all letters and unferline "_" as a spacer. For example index.rst, training_services.rst, sdk_reference.rst
- Treat all abbreviate words as one word. For example, PaiMode.md, SquadEvolutionExamples.md
PurityFan
changed the title
| @@ -157,7 +157,7 @@ Run the **config_windows.yml** file from your command line to start MNIST experi | |||
| nnictl create --config nni/examples/trials/mnist/config_windows.yml | |||
| ``` | |||
|
|
|||
| Note, **nnictl** is a command line tool, which can be used to control experiments, such as start/stop/resume an experiment, start/stop NNIBoard, etc. Click [here](NNICTLDOC.md) for more usage of `nnictl` | |||
| Note, **nnictl** is a command line tool, which can be used to control experiments, such as start/stop/resume an experiment, start/stop NNIBoard, etc. Click [here](Nnictl.md) for more usage of `nnictl` | |||
There was a problem hiding this comment.
"Nnictl" seems a little weird....
There was a problem hiding this comment.
This is for a unified doc's name.
For .md file, we use the uppercase for initial letters, no spacers. For example BuiltinTuners.md, BatchTuner.md.
There was a problem hiding this comment.
I understand. But can we have an exception for "NNI"? How about "NNIctl.md"?
There was a problem hiding this comment.
We "Treat all abbreviate words as one word. For example, PaiMode.md, SquadEvolutionExamples.md", have an exception for "NNI" maybe not a standard use?
There was a problem hiding this comment.
I think either one is okay. Since this is only file name, users would not care too much about it, let's simply unify the format, i.e., using 'Nni'?
|
Thanks for unifying the format of files' names. |
|
@leckie-chn @squirrelsc please help review~ |
