Skip to content

Move 6LoWPAN mesh configuration to its own page under Reference/Config #502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 2, 2018
Merged

Conversation

SeppoTakalo
Copy link
Contributor

@AnotherButler Please review.

@AnotherButler
Copy link
Contributor

I like the intro section on the config page. Please use the command-line to generate the configuration parameters, so they match the format of the other config pages.

@SeppoTakalo
Copy link
Contributor Author

I did not spot any instructions to for any script.
How do I run it?

Also, I don't really like the way other configuration pages are structured. The script generated lists only contain name of the configuration key, no description of its use, not range of acceptable values.

Can I still keep the tables and append the script generated lists after them?

I originally expressed my concerns here: #366
So by just listing the configuration keys, it is not enough to instruct developers to use them.

Therefore, I wan't to have intro sections and tables listing the keys, acceptable values/ranges and use cases for keys.

@theotherjimmy
Copy link
Contributor

@SeppoTakalo See https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/configuration/configuration.md#examining-available-configuration-parameters

The script generated lists only contain name of the configuration key, no description of its use,

If there is no description of it's use, then the "help" key in the configuration file is empty.

@SeppoTakalo
Copy link
Contributor Author

@theotherjimmy Thanks. And yes, you are correct. Help fields are empty.

I'll move the stuff to help section and create PR to the Mbed OS

@SeppoTakalo
Copy link
Contributor Author

Refactored the page to look like other configuration pages.
Actually most of the "help" fields were already there. I just have missed those earlier.

@SeppoTakalo
Copy link
Contributor Author

Publishing the changed also in Mbed OS ARMmbed/mbed-os#6745

@theotherjimmy
Copy link
Contributor

😃 Thanks @SeppoTakalo

Amanda Butler added 2 commits April 30, 2018 15:56
Copy edit for active voice and formatting.
Copy edit changes, mostly for active voice and inclusion of articles.
Copy link
Contributor

@AnotherButler AnotherButler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work on this 👍

@AnotherButler
Copy link
Contributor

@SeppoTakalo Can I make these changes to 5.8, or are they only for 5.9?

@SeppoTakalo
Copy link
Contributor Author

These are valid for 5.8 as well.

@AnotherButler AnotherButler merged commit 1400ff2 into ARMmbed:new_engine May 2, 2018
AnotherButler pushed a commit that referenced this pull request May 2, 2018
Update MeshInterface from #502 after reviewing on the test site.
@SeppoTakalo SeppoTakalo deleted the mesh_docs branch May 29, 2018 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants