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 docs #560

Open
3 tasks
dr-dimitru opened this issue Jan 17, 2018 · 3 comments
Open
3 tasks

Update docs #560

dr-dimitru opened this issue Jan 17, 2018 · 3 comments

Comments

@dr-dimitru
Copy link
Member

dr-dimitru commented Jan 17, 2018

Update docs and wikis.

  • Minimize amount of data presented at front page (README.md);
  • Simplify examples presented at front page (README.md);
  • Split wikis (docs) by functionality (a.k.a. API), not tasks (Howtos);
  • Differentiate feature, functionality (API), and tasks (Howtos) docs;

Articles:

  • Security
  • Publish / Subscribe
  • Using files without references and pub/sub (denormalization concepts)

Use flow-router-extra repository as example

@joephuz
Copy link

joephuz commented Feb 17, 2018

Forgive me if maybe this is the wrong thread, just adding it here since I think maybe the Template helper wiki page is out of date(I couldn't get it working by the example but perhaps I made a mistake).
The 'Streaming' section on home page appears to be correct and worked great for me... but the fileURL example gave me trouble when trying to access a sub version of fileRef. For example:

Did not work:
{{fileURL fileRef 'small'}}

Works for me (although not clearly documented), adding the sub version name as argument with the link helper:
{{fileRef.link 'small'}}

Again, sorry if this confuses this thread (Im new here) or I misunderstood something, but thanks VERY much for your hard work , this package is great and Im happy to be free from the shackles of CollectionFS!

@dr-dimitru
Copy link
Member Author

Hello @joephuz ,

Im happy to be free from the shackles of CollectionFS!

Sounds awesome, I'm glad this lib helped you :)

Helper works fine for a long time. Let's check why fileURL helper doesn't work for you:

  1. Do you get any errors?
  2. What is the fileRef in your case? Could you console.log it?
  3. Feel free to start a new issue following our issue template

@tomtom87
Copy link

tomtom87 commented Jun 3, 2020

Please fix the React examples #750

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

No branches or pull requests

3 participants