question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Create new, structured documentation

See original GitHub issue

⚠️ Work in progress

Documentation

Website

  • New homepage (based on https://date-fns.org/)
  • Quick search bar
  • Auto build after commit to master
  • Make available package changelogs after release

Content

Tutorials

  • Javascript
  • React
  • CLI
  • Testing

References

  • lingui-i18n - i18n for Javascript projects
  • lingui-react - React components build on top of lingui-i18n (resolved in #22)
  • lingui-cli and lingui-conf
  • lingui-loader
  • ICU MessageFormat

Guides

  • Migrating from 0.x to 1.x
  • Working with pure components (update, withHash props)

Discussions

  • Performance
  • Writing ICU MessageFormat by hand vs. babel-preset-lingui preprocessors
  • Custom ID vs. default message for Message IDs (related #15)

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:11 (10 by maintainers)

github_iconTop GitHub Comments

1reaction
tricoder42commented, Aug 1, 2018

Alright, I’m finally closing this one, because documentation is mostly complete. If you still feel there’s something missing, please let me know!

1reaction
tricoder42commented, Oct 25, 2017

@kirillku Absolutely, good point 👍

In short:

  • _build folder contains temporary message catalogs, one per each processed source file (babel plugins operate on single file, so I can’t generate one message catalog from all sources).
  • it can be safely ignored as well as compiled message catalogs (messages.js). Only messages.json files should be in repository.

I’ll push updated docs soon.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Create a Documentation Structure that Works for ... - K15t
Explain what actions your users should take in order to perform a task and achieve a specific goal.
Read more >
Basic and Structured Documents - RSpace Help - HelpDocs
Structured Documents are documents with a fixed structure of fields designed to hold set content types, and are created based on a stored...
Read more >
Creating structured documents | Student's digital skills
Creating a structure for a document refers to the defining of a structure for all the different types of information in it. In...
Read more >
Adding structure to your documentation pages
Customize your documentation's landing page · In Xcode, select your documentation catalog in the Project navigator. · Choose File > New > File...
Read more >
10 Tips for Structuring your Product Documentation
Developers primarily focus on creating a cool product. ... Getting the product document structure right not only makes a huge impact on ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found