Skip to content

Documentation: FAQ and Common Pitfalls #1245

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Feb 5, 2023
Merged

Documentation: FAQ and Common Pitfalls #1245

merged 9 commits into from
Feb 5, 2023
+446 −79

Conversation

bkoelman
Copy link
Member

@bkoelman bkoelman commented Jan 17, 2023 •
edited
Loading

Aside from minor infrastructure improvements, this PR adds FAQ and Common Pitfalls to the documentation website.

Closes #1248.

QUALITY CHECKLIST

  • N/A: Changes implemented in code
  • N/A: Complies with our contributing guidelines
  • N/A: Adapted tests
  • Documentation updated

Sorry, something went wrong.

@codecov
Copy link

codecov bot commented Jan 18, 2023 •
edited
Loading

Codecov Report

Merging #1245 (3eb40af) into master (be99234) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1245      +/-   ##
==========================================
+ Coverage   92.62%   92.63%   +0.01%     
==========================================
  Files         243      243              
  Lines        7795     7807      +12     
==========================================
+ Hits         7220     7232      +12     
  Misses        575      575
Impacted Files Coverage Δ
...ore/Controllers/BaseJsonApiOperationsController.cs 100.00% <0.00%> (ø)
...iDotNetCore/Middleware/JsonApiRoutingConvention.cs 92.75% <0.00%> (+0.69%) ⬆️
...etCore/Errors/UnsuccessfulActionResultException.cs 96.00% <0.00%> (+1.00%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@bkoelman bkoelman force-pushed the docs-tips branch 5 times, most recently from 01ce9fd to 05b67dd Compare January 19, 2023 01:21
@bkoelman bkoelman force-pushed the docs-tips branch 2 times, most recently from 39eae10 to f7e221e Compare January 20, 2023 02:47
@bkoelman bkoelman changed the title Fix broken examples doc generation Documentation improvements Jan 20, 2023
@bkoelman bkoelman force-pushed the docs-tips branch 3 times, most recently from f61ca57 to f2a6288 Compare January 20, 2023 22:58
@bkoelman bkoelman changed the title Documentation improvements Documentation: FAQs and Common Pitfalls Jan 20, 2023
@bkoelman bkoelman changed the title Documentation: FAQs and Common Pitfalls Documentation: FAQ and Common Pitfalls Jan 20, 2023
@bkoelman bkoelman marked this pull request as ready for review January 21, 2023 01:02
@bkoelman bkoelman requested a review from maurei January 21, 2023 01:03
maurei
maurei reviewed Feb 5, 2023
View reviewed changes
maurei
maurei suggested changes Feb 5, 2023
View reviewed changes
Copy link
Member

@maurei maurei left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This summarises pretty neatly all of the things we've run into over the past few years. Well done!

@bkoelman @maurei
Update docs/getting-started/faq.md

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
3eb40af 
Co-authored-by: Maurits Moeys <maurits.moeys@gmail.com>
@bkoelman bkoelman requested a review from maurei February 5, 2023 12:18
@bkoelman bkoelman merged commit 8e8427e into master Feb 5, 2023
@bkoelman bkoelman deleted the docs-tips branch February 5, 2023 20:35
@bkoelman bkoelman mentioned this pull request Feb 5, 2023
Closed
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maurei maurei

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs markdown: use docfx alerts
2 participants
@bkoelman @maurei