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

Add an examples page #413

Merged
merged 3 commits into from
Oct 5, 2021
Merged

Add an examples page #413

merged 3 commits into from
Oct 5, 2021

Conversation

ryanbethel
Copy link
Contributor

This adds an examples page to the docs for search index and discoverability. It has only a few examples now, but this will give us a place to link to.

Feedback requested:

  • Where should this page live in the docs. Not really sure so I put at the end for now.
  • There is one community contributed example. I would like to add more. Any suggestions on how best to highlight the distinction? Should they be grouped together or on different pages?

We really appreciate your commitment to improving Architect

To maintain a high standard of quality in our releases, before merging every pull request we ask that you've completed the following:

  • Forked the repo and created your branch from main
  • Made sure tests pass (run npm it from the repo root)
  • Updated relevant documentation internal to this repo (e.g. readme.md, help docs, inline docs & comments, etc.)
  • Linked to any related issues, PRs, etc. below that may relate to, consume, or necessitate these changes

Please also be sure to completed the CLA as it's required for your PR to be merged. A github comment will prompt you if you haven't already.

Learn more about contributing to Architect here.

Thanks again!

@ryanbethel ryanbethel self-assigned this Oct 5, 2021
@tbeseda
Copy link
Member

tbeseda commented Oct 5, 2021

@ryanbethel Take a look at #411 to see the current target for arc.codes IA. You may be able to find a good place to fit in "Examples".
The ideal place is probably not created yet or might create a big change in structure, so I can help stub it in so we don't create a new route that will then have to be a part of the redirect map.
Personally, I really like a nice top-level link for Examples to make it super easy to link to.

@ryanbethel
Copy link
Contributor Author

@ryanbethel Take a look at #411 to see the current target for arc.codes IA. You may be able to find a good place to fit in "Examples". The ideal place is probably not created yet or might create a big change in structure, so I can help stub it in so we don't create a new route that will then have to be a part of the redirect map. Personally, I really like a nice top-level link for Examples to make it super easy to link to.

@tbeseda Thanks for pointing to the outline. I remember you mentioning it but I wasn't thinking about it at the time. I think what makes the most sense is to put it at the end of the tutorials section. Does that make sense to you? Since that is not the current structure where should I put it now? Should we wait on this PR? I wanted to get it in so I could put some links to it in the archived example repos, but I can wait on that if you prefer.

@tbeseda
Copy link
Member

tbeseda commented Oct 5, 2021

Since that is not the current structure where should I put it now? Should we wait on this PR? I wanted to get it in so I could put some links to it in the archived example repos

I don't think we should wait for the larger routing changes to shake out.

"Tutorials" seems like things that have a step-by-step explainer. Maybe under the new top-level "Get Started"?
IMO a top level "arc.codes/examples" would be really nice. It could always redirect to the latest and greatest examples.

What if for now we put it in Guides > Get Started at the end of the list and create a redirect from /examples? Then when that section is built we update or create a new redirect as needed. That way you can link to /examples ASAP and it will keep working even after things get moved.

@tbeseda tbeseda merged commit dfbe561 into main Oct 5, 2021
@tbeseda tbeseda deleted the add-examples branch October 5, 2021 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants