microsoft / microsoft/react-native-windows-samples

Use doxysaurus to publish Cxx APIs docs

Open
#720 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
C#
Stars
544
Forks
218
PR merge metrics
No merged PRs in 30d

Description

last year @vmoroz had looked into using docusaurus for producing docs for the other ones, is that ready to be used on the other C++-only APIs like ReactPackageProvider etc?

filing an issue to track adding these docs

Originally posted by @asklar in https://github.com/microsoft/react-native-windows-samples/pull/719#discussion_r929456288

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the discussion in pull request #719 and the existing Docusaurus approach referenced there. Identify which C++-only APIs, including ReactPackageProvider, are in scope; done means their documentation is published through the agreed workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, react-native
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.