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

Use a Wiki section instead of one huge README.adoc #1399

Closed
Korb opened this issue Jan 8, 2025 · 1 comment
Closed

Use a Wiki section instead of one huge README.adoc #1399

Korb opened this issue Jan 8, 2025 · 1 comment
Labels
not-shitpost https://cirosantilli.com/china-dictatorship#shitpost

Comments

@Korb
Copy link

Korb commented Jan 8, 2025

Currently, it is extremely difficult to find anything useful in the monstrously large README.adoc file. I propose to use a system that is potentially much more suitable for storing cross-referenced data - Wiki, which is already included in this project.

@Korb Korb added the not-shitpost https://cirosantilli.com/china-dictatorship#shitpost label Jan 8, 2025
@github-actions github-actions bot added shitpost https://github.com/cirosantilli/china-dictatorship#shitpost meant-to-be-used https://cirosantilli.com/china-dictatorship#meant-to-be-used op-does-not-know-what-shit-is https://cirosantilli.com/china-dictatorship#shitpost and removed not-shitpost https://cirosantilli.com/china-dictatorship#shitpost labels Jan 8, 2025
@cirosantilli cirosantilli added not-shitpost https://cirosantilli.com/china-dictatorship#shitpost and removed shitpost https://github.com/cirosantilli/china-dictatorship#shitpost meant-to-be-used https://cirosantilli.com/china-dictatorship#meant-to-be-used op-does-not-know-what-shit-is https://cirosantilli.com/china-dictatorship#shitpost labels Jan 8, 2025
@cirosantilli
Copy link
Owner

Hi.

File size doesn't matter if you have a table of contents as we do in https://cirosantilli.com/china-dictatorship/

You may also be interested in the split header render: https://cirosantilli.com/china-dictatorship/index-split

Yes ideally we want things that render on GitHub itself to avoid domain censorship.

The big issue on GitHub is that the README.adoc gets cut up by github.

But I want strong interlinking to every ID via <<>> and adoc is the only format that github has that supports it.

On Wiki I'd need to put each subject in its own file to have that which would be too annoying.

So I don't see a better solution for now.

The perfect format is of course OurBigBook: https://github.com/ourbigbook/ourbigbook One day GitHub will support it.

One option would be to render a split adoc output somehow.

@Korb Korb closed this as not planned Won't fix, can't repro, duplicate, stale Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not-shitpost https://cirosantilli.com/china-dictatorship#shitpost
Projects
None yet
Development

No branches or pull requests

2 participants