taichi-dev / docs.taichi.graphics Goto Github PK

Vuepress provides plugin to support Algolia DocSearch integration, which provide more accurate and granular search results. We can try to make this integration.

I find that the below code is not working. the taichi version is 1.1.2. The code is placed at field.md

f = ti.Vector(ti.f32, n=2).field(shape=(1,2,3))

Is this the old syntax?

https://github.com/taichi-dev/docs.taichi.graphics/blob/master/website/docs/lang/articles/contribution/dev_install.md#installing-dependencies
Currently clang-10 is not available in pacman package repository, I successfully built taichi==0.8.0 with clang and llvm prebuild with this release pack.

Once #21 is done, we need to migrate the existing translated docs in Zh-cn. This can be done in multiple PRs iteratively, which is easier to be reviewed.

Acceptance Criteria:

• The existing docs are migrated
• Cross-check with the up-to-date en documentation, any outdated translation shall be removed or left blank.
• The credits of the docers who have contributed shall be honored properly in this repo too.
• Update the current taichi.graphics website:
  • Move the stack to the react based docusaurus or Gatsby or other MDX based frameworks, to better align with the existing components and libraries (some of which are internal).
  • Separate the docs and API into two different categories, both are linked from a higher level website (which will become the future taichi.graphics).
  • Clean up the main repo's doc related PRs. (We'd better create a mirror issue in the main repo before starting this task)
  • Add instructions for contributors about how to contribute under the new structure, in both docs and the main repo. (We'd better create a mirror issue in the main repo before starting this task)

The targeted docs infrastruture is illustrated by the following diagram:

There is no page flip button on the blog page: https://docs.taichi-lang.org/blog.

The current page cannot accommodate all blogs, which are arranged chronologically. The earliest piece should be "Head First Taichi", published in October 2021, but it does not appear on the page. Readers can only access it by clicking on the corresponding tags. Otherwise, they just scroll down to the bottom and would assume that there is no other resource available.

Can we put all blogs on the same page or add a page flip button to indicate that we have more to provide?

Light mode:

Dark mode:

:::note
Blabla
:::

The current color and logo of note:

Reference link:

• https://docs.taichi-lang.org/docs/accelerate_python
• https://docs.taichi-lang.org/docs/doc_writing#custom-containers

:::tip
Blabla
:::

The current tip logo:

Reference link:
https://docs.taichi-lang.org/docs/doc_writing#custom-containers

We don't use the colors of "info", because for now we don't have this type of note.

The existing zh-cn documentation source repo has a well-designed streamlined translation workflow It was designed to work with documentation written in .rst files. With the new docsite, we need to migrate the translateion workflow first before migrating the zh-cn docs themselves.

Related discussion: https://github.com/taichi-dev/taichi.graphics/pull/17#discussion_r511641423

1: All APIs after 'abstract' ought to be filtered.

2: Blog search results ought to come after doc and API. So, in an instant search window, doc results always come first, API search results come second, and blog results come last.

3: The preview of the search result page is spoiled (codes of different lines are put together)

Crowdin incorrectly changes all types of formattings around admonitions, which will break the vuepress styles, need to think about how to fix it.

Originally posted by @rexwangcc in https://github.com/taichi-dev/taichi.graphics/pull/27#discussion_r527368646

After taking a look at others' discussions who have encountered this bug (see casbin/casbin-website#95), I believe the most efficient way to resolve this is to contact Crowdin support directly.

https://github.com/taichi-dev/docs.taichi.graphics/blob/master/website/docs/lang/api/index.md

Project link: https://crowdin.com/project/taichi-programming-language/zh-CN

Theoretically, documents on the Crowdin project page should be identical to those on the doc site. But now you will find different versions of the same documents under a file. For example, under the "get_started" file, index.md should have been deleted and replaced by hello_world.md.

How can we ensure that the Crowdin project is promptly updated along with the doc site changes?
BTW, we are now using Crowdin CLI 3.6.0, while the latest version is 3.10.0. Do we need to update the tool?

We have API reference embedded in http://docs.taichi.graphics/, so the previous hack of https://api-docs.taichi.graphics/ can be removed safely.

Currently contributors are listed here at https://taichi.graphics/community/members.html#active-contributors by manual markdown editing, while it's necessary to maintain Technical Steering Committee, Committers and Reviewers lists maunally, it would be better if we could have a more automated way to display active contributors.

Existing solutions include:

• Write a script and CI job to automatically update the list of contributors from Github (multiple repos). Example: https://fastapi.tiangolo.com/fastapi-people/
• Use integrations provided by Open Collective. Example: https://github.com/SpaceVim/SpaceVim#support-spacevim

For the initial implementation, we don't have to go fancy as including images and names, simply generating a list of Github user ids might be enough.

All of the search results are categorized under docs, such as https://docs.taichi.graphics/search?q=field or https://docs.taichi.graphics/search?q=high%20performance%20computing, which is confusing. Reported by @qiao-bo

• Laptop: MacBook Pro
• Web browser: Chrome
• How to reproduce: After I type docs.taichi-lang.org, the landing page shows the 'develop' branch. I suspect this is due to the cache. And If I use an Incognito window, then this issue would not occur.
• Expected behavior: The landing page ought to show the latest published release, v1.1.3 in this case, not the develop release.
  

No since we have plan to separate documentation articles (as well as generated API reference) from the main repo, we need to think carefully about how to craft/update the release workflow so it won't produce extra burden to the releaser(s) once we get rid of the rst docs in the main repo.

This is related to taichi-dev/taichi#1674

It's a huge plus if we can let users export documentation to PDF files so they don't have to be online to check the docs.

Note: This can happen at either build time or in-broswer, depends on which is easier to implement.

Once #21 and #22 are both done, we shall add a documentation for other docers or new comers about how to participate in translating the documentation using Crowdin.

import taichi as ti
import numpy as np
import time
ti.init(arch=ti.cuda)#,debug=True)
n=1<<18
a=np.random.randn(n).astype(np.float32)
b=ti.field(ti.f32,n)
b.from_numpy(a)
@ti.kernel
def sum1()->ti.f32:
    result=0.0
    for i in b:
        result+=b[i]
    return result
#compile
sum1()
t1=time.time()
for _ in range(1000):
    a.sum()
t2=time.time()
for _ in range(1000):
    sum1()
ti.sync()
t3=time.time()
print('time numpy:',t2-t1,'time ti atomic_add:',t3-t2)
input('enter to continue')

result in RTX3060 and R7 5800H is：

time numpy: 0.07301616668701172 time ti atomic_add: 0.3090794086456299

Shall we move:
https://taichi.graphics/versioned_docs/develop/documentation/advanced/meta.html
to:
https://taichi.graphics/docs/develop/advanced/meta.html