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 is completely gone #383

Open
xaddict opened this issue Jul 18, 2022 · 6 comments
Open

Documentation is completely gone #383

xaddict opened this issue Jul 18, 2022 · 6 comments
Assignees
Labels

Comments

@xaddict
Copy link

xaddict commented Jul 18, 2022

Describe the bug
This repo points to https://fontawesome.com/docs/web/use-with/vue/ for documentation on how to use the component, but that page points to https://fontawesome.com/v5/docs/web/use-with/vuejs and THAT page in turn points to either this repository or https://fontawesome.com/docs/web/use-with/vue/ (which doesn't have any documentation on the power transforms or Vue component props). So it seems all the documentation is gone now.

There used to be a dedicated page where vue-fontawesome was explained.

Expected behavior
A markdown file or other way to read the documentation on how features of Font Awesome are usable in vue-fontawesome

@jasonlundien
Copy link
Member

jasonlundien commented Aug 12, 2022

Hey there @xaddict --

You are correct, the repo points to: https://fontawesome.com/docs/web/use-with/vue/

But where are you seeing we are redirecting to v5 docs?

but that page points to https://fontawesome.com/v5/docs/web/use-with/vuejs

@kylepulver
Copy link

not the original poster, but i actually made my way here because of the issue of seemingly no documentation on the component.

the docs here: https://fontawesome.com/docs/web/use-with/vue/ show the setup, but that's all. i just noticed that all the way down the left side on the sidebar there are the following links:

  • Set Up with Vue
  • Add Icons with Vue
  • Adding Icon Styling with Vue
  • Dig Deeper
  • Use Vue With...
  • Troubleshoot

None of these links work, as they direct to headers that do not exist on the installation page. Instead the headers are:

  • Add SVG Core
  • Add Icon Packages
  • Add the Vue Component
  • You're Ready to Add Icons!

I might have missed something incredibly obvious but the only way I could find out what props were available for the component was to look at the source directly

@xaddict
Copy link
Author

xaddict commented Aug 13, 2022 via email

@jasonlundien
Copy link
Member

jasonlundien commented Aug 15, 2022

This is interesting for sure. I see what you are saying by clicking the link provided (https://fontawesome.com/docs/web/use-with/vue/). If you click on the side link(s) it seems to always take you to the setup page for Vue.

Yet this is the same url as when you "manually" visit www.fontawesome.com, click on Docs, Web, Setup with Vue. All the links in the side menu seem to be working fine doing it this way... yet the links do NOT work when you click the link we provided... weird. Hmmm, ok. Thank you for pointing this out, I will get this fixed up !!!

@jasonlundien jasonlundien linked a pull request Aug 17, 2022 that will close this issue
@jasonlundien
Copy link
Member

Ok, we have a temporary fix going in. Bottom line, there is a bug, we believe, with our fontawesome vue-press docs and how it is rendering the pages for our vue, and only vue, docs it appears. We are getting a console error of Cannot read properties of undefined (reading '_transitionClasses') in our production environment, as you all have seen. Yet our dev environment is not seeing the same result so we need to spend some time on reproducing this in our local dev.

I am going to keep this open so we can spend a little more time on this one. Thanks for bringing this to our attention, greatly appreciated!

@jasonlundien
Copy link
Member

Fix on PR: Update docs for new links
#497

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

Successfully merging a pull request may close this issue.

3 participants