hodgestar
commented
1 year ago I'm definitely in favour of making the HPy - A better C API for Python bigger and more central.
Our users and community are perhaps a bit different to React or the sports club, so I'm trying to think through what kinds of people will arrive at our website and what they'll be looking for:
-
People who want to know what HPy is. They're likely Python developers who have heard about HPy and I want to know more. They're looking for a clear high-level summary of the main points with links to examples, more detail and reference documentation in case they want to know more.
-
People who are evaluating HPy. They might be core developers of a Python implementation or just developers in such topics. They need a high-level summary of the benefits, design choices made, a high-level summary of the porting process and a link to a thorough example of porting an existing C extensions to HPy. They'll want to know how extensions are compiled, how ABI versioning and compatibility works, and have an overview of what parts of the C API have been ported.
-
People who want to port an existing C extension to HPy. They new a high-level summary of the porting process, a detailed example and links to reference documentation.
-
People who want to create a new C extension using HPy. They need a tutorial, guides to particular tricky topics (e.g. HPyGlobal, argument parsing, string and tuple building), and links to reference documentation.
-
Potential HPy contributors. They need a welcoming message, a short guide to the development process, a link to the development Discord server, and perhaps an overview of the current state of development or a development roadmap.
Everyone needs to know where to reach out for help or clarification if they get stuck.
This is quite a big todo list, and I don't know if everyone will agree with it 100%, but we do have a chunk of this content already, we just need to expose and organize it better.
@novialriptide As a concrete next step, I would suggest producing a mock-up of the overall site structure (perhaps just the front page with notes saying "clicking this leads to ..."). Then everyone can chime in with what content we already have and everyone can help re-organize / improve / add to it as necessary.
novialriptide
How's this looking so far?
Few Suggestions
Remove the header "HPy - A better C API for Python" and turn it into a "hero" section to something similar to this: "The React Framework for the Web"
Move
"What is HPy"contents to the hero section and just have"HPy provides a new API for extending Python in C. In other words, you use #include <hpy.h> instead of #include <Python.h>."Convert the features section into something like this (https://rutgersesports.club):