Skip to content
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

DOCUMENTATION: Moved installation instructions to separate page #561

Merged
merged 5 commits into from Aug 17, 2017

Conversation

Raienryu97
Copy link
Contributor

  • Added Fedora to contents table
  • Added Issue/Bug Report section to README
  • Some minor improvements

* Added Fedora to contents table
* Added Issue/Bug Report section to README
* Some minor improvements
@copercini
Copy link
Contributor

NICE!

Just an observation: If rename the folder "doc" to "docs" Github accept it's documentation (like ISSUE_TEMPLATE) inside this, cleaning the root folder

* Also move ISSUE_TEMPLATE.md to docs directory
* This makes it consistent instead  of having few local and few pointing to
  espressif/arduino-esp32 by all linking to local files
@Raienryu97
Copy link
Contributor Author

Great idea @copercini . I've also linked all links to local files wherever possible so it would be consistent and I felt it makes more sense than pointing to espressif/arduino-esp32 even in forks.

@me-no-dev
Copy link
Member

is this ready for merging?

@Raienryu97
Copy link
Contributor Author

Raienryu97 commented Aug 5, 2017

Yep. Done from my side.

Edit: (6th Aug)
Fixed a small typo. Commit pushed.

@copercini
Copy link
Contributor

Maybe the "Contents" summary and "Installation Instructions" can be suppressed in just one thing, because both have almost the same links

@Raienryu97
Copy link
Contributor Author

Raienryu97 commented Aug 8, 2017

How about the current one @copercini , @me-no-dev ?
You can see it here

@copercini
Copy link
Contributor

@Raienryu97 Awesome!

@me-no-dev me-no-dev merged commit e6ba0f6 into espressif:master Aug 17, 2017
Raienryu97 added a commit to Raienryu97/arduino-esp32 that referenced this pull request Aug 18, 2017
…essif#561)

* DOCUMENTATION: Moved installation instructions to separate page

* Added Fedora to contents table
* Added Issue/Bug Report section to README
* Some minor improvements

* DOCUMENTATION: Rename directory doc to docs

* Also move ISSUE_TEMPLATE.md to docs directory

* DOCUMENTATION: Use current repo's files

* This makes it consistent instead  of having few local and few pointing to
  espressif/arduino-esp32 by all linking to local files

* DOCUMENTATION: Fix hyperlink to issue/bug template in contents

* DOCUMENTATION: contents: supress platform specific installation instruction
@Raienryu97 Raienryu97 deleted the upstream branch August 18, 2017 05:12
@VojtechBartoska VojtechBartoska added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Jun 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants