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

docs: Fix broken links. Prettify URLs #1015

Merged
merged 8 commits into from Apr 19, 2021
Merged

docs: Fix broken links. Prettify URLs #1015

merged 8 commits into from Apr 19, 2021

Conversation

clockworkgr
Copy link
Collaborator

No description provided.

ilgooz
ilgooz previously approved these changes Apr 16, 2021
@fadeev
Copy link
Contributor

fadeev commented Apr 16, 2021

Added titles and order properties. Not sure whether we should have dirs like 2-Scaffold-A-Blockchain or just scaffold to keep URLs lean.

Also, @clockworkgr do we not have Netlify deploy previews for docs?

@barriebyron
Copy link
Contributor

barriebyron commented Apr 16, 2021

you all are so awesome and fast, thank you.
we can also add frontmatter description metadata to improve SEO.
I showed Tobias and he liked the progression on the 1, 2, and so on at the topic level, but I agree with @fadeev that we can likely keep the folder name without an order number. lmk how I can jump in and help. I had inadvertently started another branch to fix these links and filenames, but I was too slow. Instead, I bow in humility to you speedy fixers.

@clockworkgr
Copy link
Collaborator Author

Added titles and order properties. Not sure whether we should have dirs like 2-Scaffold-A-Blockchain or just scaffold to keep URLs lean.

Also, @clockworkgr do we not have Netlify deploy previews for docs?

Hm.. added previews for PRs...(on tendermint/vue it was set automatically/by default for some reason, but not on this repo)

@clockworkgr
Copy link
Collaborator Author

you all are so awesome and fast, thank you.
we can also add frontmatter description metadata to improve SEO.
I showed Tobias and he liked the progression on the 1, 2, and so on at the topic level, but I agree with @fadeev that we can likely keep the folder name without an order number. lmk how I can jump in and help. I had inadvertently started another branch to fix these links and filenames, but I was too slow. Instead, I bow in humility to you speedy fixers.

search and replace can be a life saver :)

@fadeev
Copy link
Contributor

fadeev commented Apr 19, 2021

I've added page descriptions into this PR (thanks, @barriebyron, for writing them!), and switched to short URLs. Should be ready for review.

docs/configure/intro.md Outdated Show resolved Hide resolved
docs/configure/reference.md Outdated Show resolved Hide resolved
docs/intro/quickstart.md Outdated Show resolved Hide resolved
docs/intro/quickstart.md Outdated Show resolved Hide resolved
@fadeev fadeev requested a review from ilgooz April 19, 2021 10:16
@ilgooz ilgooz merged commit 1779a6f into develop Apr 19, 2021
@ilgooz ilgooz deleted the docs/urls-update branch April 19, 2021 11:16
Jchicode pushed a commit to Jchicode/cli that referenced this pull request Aug 9, 2023
* docs: Fix broken links. Prettify URLs

* chore: Update theme dependency

* Added explicit ordering and titles

* Simplified URLs

* Added descriptions

* Relative links

Co-authored-by: Denis Fadeev <denis@fadeev.org>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
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.

None yet

4 participants