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

Update links in documentation #424

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AnotherButler
Copy link
Contributor

NO CONTENT CHANGES

  • Attempt to fix broken links throughout published documentation

NO CONTENT CHANGES
- Attempt to fix broken links throughout published documentation
@AlessandroA
Copy link
Contributor

Hi @AnotherButler, thanks for the PR. Unfortunately, these changes break the document navigation within GitHub.

The docs folder structure in this repo is as follows:

.
├── CONTRIBUTING.md
├── README.md
├── SECURE_CODING.md
└── docs
    ├── README.md
    ├── lib
    │   ├── API.md
    │   ├── DEBUGGING.md
    │   ├── QUICKSTART.md
    │   └── manual
    │       ├── Makefile
    │       ├── README.md
    │       ├── Technical.md
    │       ├── UseCases.md
    │       ├── example.md
    │       ├── images
    │       │   ├── memory_layout.png
    │       │   └── memory_layout.svg
    │       └── template
    │           └── pandoc-template.docx
    ├── core
    │   ├── DEVELOPING_LOCALLY.md
    │   └── PORTING.md
    ├── img
    │   ├── memory_layout.png
    │   └── memory_layout.svg
    └── index.md

For example, linking API.md from the top-level README.md file requires the link docs/lib/API.md. Would it be possible to recreate exactly this structure in the online docs? Otherwise, we will always have either the GitHub or the online links broken.

@AnotherButler
Copy link
Contributor Author

@iriark01 Can you answer this?

@iriark01
Copy link
Contributor

iriark01 commented May 5, 2017

With mbed OS and mbed Cloud we don't consider it a problem that links only work on the docs site. uVisor is a bit different. But why can't the structures match?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants