Skip to content
This repository was archived by the owner on Apr 24, 2019. It is now read-only.

Moved the problem chapter under Building. #197

Merged
merged 3 commits into from
Mar 9, 2017
Merged

Moved the problem chapter under Building. #197

merged 3 commits into from
Mar 9, 2017

Conversation

peknis01
Copy link
Contributor

@peknis01 peknis01 commented Mar 3, 2017

Any better? Just let me know if we need more reorganizing.

@yogpan01
Copy link
Contributor

yogpan01 commented Mar 3, 2017

@bridadan Is this fine now ?

Copy link
Contributor

@yogpan01 yogpan01 left a comment

Choose a reason for hiding this comment

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

@bridadan to provide the comments.

Copy link
Contributor

@bridadan bridadan left a comment

Choose a reason for hiding this comment

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

It's a start, but it's not really addressing the problem right?

It wasn't just a problem with the position of the text, but the way it's framed. The addition of the .mbedignore file is a required step for the WIFI_ODIN configuration, not a workaround that you could use should you run into a problem. I feel like it should be reflected in the README like this.

Ideally, I think the instructions would be something like:

  • Welcome and intro information
  • Steps
    1. Prerequisites
    2. Hardware
    3. Config options for Connectivity
      • Ethernet
      • Mesh
        • Common mesh instructions
        • 6LOWPAN
          • Border router specific instructions
        • Thread
          • Border router specific instructions
      • WiFi
        • ESP8266
        • ODIN options (including .mbedignore instructions!)
    4. Build
    5. Test
  • Maybe some follow-up/troubleshooting

Like I mentioned before, almost all of this is already there (steps 1, 2, 4, and 5 specifically). But it's the config/pre-build instructions that are really the important bits!

@peknis01
Copy link
Contributor Author

peknis01 commented Mar 6, 2017

Yogesh, your call. I think you could do some initial stuff here and I'll check then how it looks.

@bridadan
Copy link
Contributor

bridadan commented Mar 6, 2017

I realize this might be a lot of changes to get in before the release, but I thought I'd bring it up. The changes here definitely look good, but I think we can still improve the instructions for new people coming into mbed.

EDIT: "look good" as in should still come in as is if the other changes don't happen.

Getting back to the restructuring later.
@yogpan01
Copy link
Contributor

yogpan01 commented Mar 9, 2017

@bridadan I will merge this PR now and we will follow-up on your proposal in a separate PR.
@peknis01 FYI

@yogpan01 yogpan01 merged commit 6f1f23f into master Mar 9, 2017
@JanneKiiskila JanneKiiskila deleted the doc_fix branch March 15, 2017 07:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants