brython-dev / brython

Brython (Browser Python) is an implementation of Python 3 running in the browser
BSD 3-Clause "New" or "Revised" License
6.39k stars 511 forks source link

[List] Suggestions regarding the Documentation #2257

Open denis-migdal opened 1 year ago

denis-migdal commented 1 year ago

Here a list of suggestions regarding the Brython documentation : @PierreQuentel For each items, if you answer 'no', I'll remove them from the list.

denis-migdal commented 1 year ago

Here an example for the page menu :

Screenshot 2023-10-05 at 19-39-46 KeyApp

details {
    position:fixed;
    right:5em;
    top: 5em;
    z-index: 100;
    background: var(--color-box-body);
    border: 1px solid gray;
    border-radius: 5px;
    padding: 10px;
    padding-right:20px;
    margin-bottom: 0px;
    & > ul { margin-bottom:0px
    } }
<details open=""><summary>Table of Contents</summary><ul>
<li>
<a href="#user-content-keyapp" rel="nofollow">KeyApp</a></li>
<ul>
<li>
<a href="#user-content-links" rel="nofollow">Links</a></li>
<li>
<a href="#user-content-commands" rel="nofollow">Commands</a></li>
<li>
<a href="#user-content-install" rel="nofollow">Install</a></li>
<li>
<a href="#user-content-custom-css" rel="nofollow">Custom CSS</a></li>
</ul>
</ul>
</details>
denis-migdal commented 1 year ago

I read some comments online about Brython, and it seems its advantages aren't clear enough :

E.g. "4 reasons to use Brython:"

  1. Ofc, not requiring to learn JS if you know Python / same language client/server / easy learning curve.
  2. Use Python-like API or access full JS/DOM API a. With easy interactions JS <=> Python. b. Support usage of both Python and JS existing library in Python
  3. Performant : JIT and pre-compiled.
  4. Better than alternatives ? (cf also) a. Well maintained compared to alternatives b. Full CPython support. c. Small size compared to alternatives that ships Python interpreter (200kB once compressed vs 10MB). d. Faster (link to benchmark see this) e. Big community (6k stars)

I think that once perfs are improved (cf related issue), and documentations restructured, we could contact some specialized Python/Info news websites (e.g. developpez.com in France) to promote Brython and inform people of the recent changes ? Could help Brython adoption (?).

denis-migdal commented 1 year ago

Added lot of suggestions for the Website Menu.

denis-migdal commented 1 year ago

Another issue related to documentation : #980.