search

alpaca-core / ac-local

Alpaca Core local inference SDK
MIT License
3 stars 0 forks source link

Create documentation infra #44

Closed iboB closed 1 month ago

iboB commented 4 months ago
tzanko-matev commented 2 months ago

I created initial infastructure to generate the docs from the C/C++ header files using Doxygen. We also created initial documentation (ref #81). We should continue working on this when:

1) We have written wrapper APIs for more languages 2) We have designed the model manifest as well as created some examples of model manifests 3) We have specific requests from the frontend developer who will prepare the final documentation website.

Until then I consider the issue to be blocked

iboB commented 2 months ago

Reviving this. We need to start working on the documentation.

  1. First we'll restore the Doxygen C++ docs
  2. Then we'll generate Doxygen C docs (not from the same state, and experiment with crossrefs)
  3. Then we'll move on to Java and Swift

As a whole, the plan would be to generate independent intermediate (xml) files which are then to be joined by an external tool into a single website

iboB commented 2 months ago

As per https://github.com/alpaca-core/alpaca-core/discussions/21#discussioncomment-10833197 also removing Doxygen generation from CMake

iboB commented 1 month ago

Ok... some progress has been made. I consider this blocked again until we have movement on the website front.

iboB commented 1 month ago

Moving with new development here: https://github.com/alpaca-core/docs.alpaca-core

iboB commented 1 month ago

Docs infra for this repo seems to be complete