Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki Content - Flow and Design #8

Open
mikey-b opened this issue Jul 12, 2021 · 3 comments
Open

Wiki Content - Flow and Design #8

mikey-b opened this issue Jul 12, 2021 · 3 comments

Comments

@mikey-b
Copy link

mikey-b commented Jul 12, 2021

Hi all,

I would like to offer creating some articles for the wiki, ranging from stubs that might be of historical interest, to full articles.

I am happy to work with the git pull request workflow, but I've a few things Id like to discuss first that would help me with this task.

  1. I would like a way to pre-discuss an article.
    I love to read and learn about these things, but a good way to determine the suitability of an article or topic would be great, so not to waste time writing unnecessarily. I am also no expert, I can certainly lay some foundational information, but someone else might be more informed and willing to do the writing than me.

Off the bat, a topic discussion in #proglangdesign might work. Or a layout PR which shows the outline of the articles might work too?

  1. Styling / Templates
    Most topics are quite interlinked, It would be great to have a standardised way to say "Successor to". Also, referencing other related topics.

I think it would be beneficial to tag concepts or algorithms too, Big O seems wise. But maybe year of research/publication?

I think these are standard bits of infromation in a wiki, but I have no idea how to do this in an md file?

Kind regards,
Mike Brown

@HackerFoo
Copy link
Member

IRC, Reddit, or Discord would be good places to gauge interest for a topic. It might be worth posting new articles to the subreddit.

The only constraint on styling and format would be to preserve existing conventions unless there is justification to change them, just to minimize churn. I find that conventions appear over time, so it might be best to just start submitting smaller PRs to see the best way to do things, and then we can edit earlier articles to match.

@mikey-b
Copy link
Author

mikey-b commented Jul 12, 2021

Hi HackerFoo,

Yep OK - Is the current styling documented, or just to review the articles that exist?

Kind regards,
M

@HackerFoo
Copy link
Member

Just the existing articles as far as I know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants