This approach couples the NPLinker release with the webapp doc. We should make them decoupled. It's ok to publish doc when there is a github release, but usually we also manually publish doc (frequently), e.g. for the doc on the latest commit of dev branch.

In NeuroGym, we typically publish documentation automatically in sync with GitHub releases. When minor doc updates are made after a release (not warranting a new version), we occasionally trigger a manual doc release. What’s the downside of this approach in your view?

An alternative approach could be to decouple the doc release from GitHub releases entirely by using a dispatch-triggered workflow. This would give you full flexibility: you could choose to publish the docs manually at any time, or let the action run and automatically update the readme from the webapp. What do you think? @CunliangGeng

It's great to publish the doc when making a github release, but, strictly speaking, not that good to just make a github release in order to publish the doc, because it violates the Semantic Versioning: whenever version changes, there should be updates in feature/code instead of only changes in doc.

We can keep the current action. Moreover, I think we still need the following features:

1. build all doc (including the webapp readme) on local machine for doc development purpose
2. manually publish doc from local machine
   For these, it's ok to create two make commands to download webapp readme to current repo and build/public doc.

Thus the doc will be published when there is a github release, you can manually update the doc without changing release version, and you can develop, build and view doc locally before publishing it.

It's great to publish the doc when making a github release, but, strictly speaking, not that good to just make a github release in order to publish the doc, because it violates the Semantic Versioning

I totally agree, and indeed when this is the case we don't make a new github release, but we just deploy the docs manually. This way is: default case, github release + docs publishing (full convenient automation). When needed because of more edits to the docs: manual docs release.

1. build all doc (including the webapp readme) on local machine for doc development purpose
   manually publish doc from local machine

I've now added the updated webapp readme, and I've rendered it locally. It seems good to me. Let me know if I can proceed with the manual docs release. I will overwrite 2.0.0a9, right?

2. For these, it's ok to create two make commands to download webapp readme to current repo and build/public doc.

Since the first command is just one line and the second only two, I'd prefer to document all three directly in the dev README instead of adding two separate make commands. If you agree I’ll proceed.

@CunliangGeng I've added the commands to the make file, updated accordingly the workflow for the automatic docs deployment and the dev docs for the manual one. I've also already released the new docs with the webapp readme page on both dev and 2.0.0a9 versions.