Enhance documentations - Githubissues

paion-data / aristotle

A web servide enables you to create knowledge graph.

https://aristotle-ws.com

3 stars 0 forks source link

Enhance documentations #14

Closed QubitPi closed 5 days ago

QubitPi commented 5 days ago

Changelog

Added

Changed

Refined documentation literature:
- @Doom9527 Whenever we can say "we", we never use "you" in documentation. For example:
```
- You can access the API documentation at `doc.html` on your local server.
+ We can then access the API documentation at `doc.html` on our local server.
```
This is a little psychological tactic[^1] that makes our product more inclusive to all potential users. It also makes you more welcomed to others in daily life communications 😉

[^1]: What “you” and “we” say about me: How small shifts in language reveal and empower fundamental shifts in perspective

Deprecated

Removed

Deleted wrong CNAME file (@Doom9527 If you don't know or not sure about anything, ask rather than push blindly)

Fixed

Security

Checklist

[x] Test
[x] Self-review
[x] Documentation

Doom9527 commented 5 days ago

OK, I have learned this usage.