Discussion on "Oveview" by pioyi (@pioyi, 6)
#2 by Ciro Santilli (@cirosantilli, 34) See all (2) New discussion
Last time I annoy you. I saw there was a typo on the title. There are two ways to handle that:
We really want to add a simple on click web UI way to make synonym renaming without typing.

Comments (15)

#1 by pioyi (@pioyi, 6) on 2024-08-18
Thanks for all the tips. I will start using the cli version, it seems much more comfortable, at least for me
#2 by Ciro Santilli (@cirosantilli, 34) on 2024-08-18
Yes, give it a try and let me know if you face any issues. I want both to be amazing, but perhaps cli is a bit better now for those who can use it. Give the Visual Code Extension a try.
#3 by pioyi (@pioyi, 6) on 2024-08-18
Wow I must have seriously messed up. Not only did I manage to make duplicates of my current article, but also somehow got my home webpage to crash. I surely am a bad user! At least I got my local file uploaded, not in the way I wanted though (inheritance is not working as expected from the file structure. But that probably is my fault).
Also maybe some things to check (not that they are 100% bugs): 1) When viewing parent/children articles sometimes the dropdown menu doesn't work when clicked (the upside down triangle). 2) Why not just delete articles instead of unlisting them? Isn't it bad for the server's storage?
I feel kind of bad for all the requests that I am making, I should preview my stuff before committing it.
My new article seemed awesome when I previewed it via the index.html file but when I uploaded it (with --web) the inheritance was broken. Maybe that's because the article already existed and I tried to push it again! Yes, that makes sense.
#4 by Ciro Santilli (@cirosantilli, 34) on 2024-08-19
I'll check the homepage 500 issue. The more bugs found the better!
Also maybe some things to check (not that they are 100% bugs): 1) When viewing parent/children articles sometimes the dropdown menu doesn't work when clicked (the upside down triangle).
1) Do you mean on table of contents? It's currently broken: docs.ourbigbook.com/todo#toc-js-folding-broken-on-web I have to fix this, it just keep escaping the top of my list somehow.
2) My idea is to one day allow storing undeletable post history as well, so that when you link to someone's permalink, it NEVER ever goes down. This is similar to what Wikipedia and Stack Overflow do. If this ever becomes a problem we can reconsider, but generally speaking storage is cheap and CPU-hours are relatively expensive.
My new article seemed awesome when I previewed it via the index.html file but when I uploaded it (with --web) the inheritance was broken. Maybe that's because the article already existed and I tried to push it again! Yes, that makes sense.
I'll have a look at what you mean when I can restore your homepage :-) Also, if you manage to push your .bigb files into a github repo, that might help debug/understand issues (even though ultimately I should be able to figure it out from db).
I feel kind of bad for all the requests that I am making, I should preview my stuff before committing it.
Not at all, if anything comes up feel free to immediately comment without too much thinking. Because I have basically no users besides myself, any feedback is extremely valuable in guiding what I should do next.
#5 by Ciro Santilli (@cirosantilli, 34) on 2024-08-19
OK I fixed the homepage problem: ourbigbook.com/pioyi at: github.com/ourbigbook/ourbigbook/commit/e586bfa5cd977b55d16198193630cd892b4404b7 It was linked to an edge case of unlisted articles I hadn't tested.
Later on let me know how your local files look for --web upload. In principle, everything should work even if the articles already exist on server, it should just restructure everything to look exactly like your local output tree.
#6 by Ciro Santilli (@cirosantilli, 34) on 2024-08-19
I fixed the toc folding at: github.com/ourbigbook/ourbigbook/commit/4a3bf763572fa56510fbd4637233236ea244195f
#7 by pioyi (@pioyi, 6) on 2024-08-20
Some more things that I encountered as I tried to add a second article: Whenever I publish something new from my terminal, I am immediately logged off and I have to keep logging back in to make small changes to the articles that I have written.
Also I couldn't publish a second article correctly. It seemed like name clashes were present, as I had made a second "references" section for the second article. But why is that? Shouldn't it all be allowed as the two "references" sections have different parents and thus are not identical. I am most probably missing something there, but I couldn't find an easy solution to my problem by reading the docs. (I keep my .bigb files in a separate directories and publish whichever one I want. I don't know if that's the correct way though.) I tried following your web editor suggestion and renaming my "references" section to "references | [article name]" but when executing the command, no changes were found.
I remember that I published my first article with a hack that I have already forgotten. And this of course is not the standard way that you wanted. I find the publication process a bit too complex for a beginner, especially for one who has no knowledge of computer science! (thankfully I have some, but even this was not enough in my case. I even watched some videos on how to publish projects and yet I couldn't find a way that made me comfortable).
Again, I apologize for my misuse of the website. I am surely not reading the docs enough.
P.S: Is there a way to not have a new line every time I put some latex in the text? Also: My new article's structure looks like this:
For some reason Bleach was never put as an actual section in the web, but instead all of the children nodes were published parentless. Why is that?
#8 by pioyi (@pioyi, 6) on 2024-08-20
Oh had no idea this was the same markdown. meant to say: equals Bleach {scope}
equals equals whatever
#9 by Ciro Santilli (@cirosantilli, 34) on 2024-08-20
Some more things that I encountered as I tried to add a second article: Whenever I publish something new from my terminal, I am immediately logged off and I have to keep logging back in to make small changes to the articles that I have written.
I am aware of the logoff issue, and I will solve it soon, it's on the top of my list. I created a issue for it now: github.com/ourbigbook/ourbigbook/issues/325
One important thing though: there is currently no way to sync server -> local, only local -> server.
I really want to do this, but it is potentially hard because of how to handle merge conflicts. Which in turn requires some kind of history implementation for us to know who is outdated, local, server or both.
So for now, once you start doing things locally, don't ever edit on server, or else the next local push will just erase everything you edited on server.
I summarized this on a new ticket as I couldn't find one: github.com/ourbigbook/ourbigbook/issues/326
Also I couldn't publish a second article correctly. It seemed like name clashes were present, as I had made a second "references" section for the second article. But why is that? Shouldn't it all be allowed as the two "references" sections have different parents and thus are not identical.
To achieve that you have to use {scope} in both, this is what I was trying to say at: ourbigbook.com/go/discussion/1/pioyi/oveview and related docs: docs.ourbigbook.com/#h-scope-argument
Something like:
= Hydrogen sulfide
{scope}

== References

=== Book 1 by John Smith

= Hydrogen oxide
{scope}

== References

=== Book 2 by John Smith
which produces IDs/URLs:
/hydrogen-sulfide
/hydrogen-sulfide/references
/hydrogen-sulfide/book-1-by-john-smith
/hydrogen-oxide
/hydrogen-oxide/references
/hydrogen-oxide/book-2-by-john-smith
Without scope it would be:
/hydrogen-sulfide
/references
/book-1-by-john-smith
/hydrogen-oxide
/references
/book-2-by-john-smith
and so you get a conflict on references and it blows up.
I understand this is not how systems most people use work and it can be a bit confusing, but I strongly believe that this is a desirable feature and one of the great "innovations" of OurBigBook.
Already in this example we can see that /hydrogen-sulfide/book-1-by-john-smith is not a very good ID, we would rather want just /book-1-by-john-smith for it.
I.e., when you start scoping, how do you unscope things?
Or consider for example the insanely deep nodes that I have in my tree such as: ourbigbook.com/cirosantilli/sequence-and-organization-of-the-human-mitochondrial-genome-by-sanger-et-al-1981 at depth 40.
If we automatically added each ancestor ID to each ID, we would have IDs that don't even fit in allowed URLs anymore.
In order to get topics hits across multiple users, we need short IDs, and not auto scoping by ancestors by default is the best bet.
I remember that I published my first article with a hack that I have already forgotten. And this of course is not the standard way that you wanted. I find the publication process a bit too complex for a beginner, especially for one who has no knowledge of computer science! (thankfully I have some, but even this was not enough in my case. I even watched some videos on how to publish projects and yet I couldn't find a way that made me comfortable).
Again, I apologize for my misuse of the website. I am surely not reading the docs enough.
These are perfectly valid points, do criticize freely, and perhaps inevitable killer blows to the success of this project.
Ultimately, full user convenience can only come when WYSIWYG is done on Web UI and local, and perfect sync happens between them. Which I want to do. It's just a question of should I do content first to try and get regular users or after these potentially big tech steps (because as it may be obvious, I've done far too much tech, with far too few users besides myself to this point).
The scoping issue above is inevitable I believe: a "small" paradigm shift that makes our key innovation work (topics).
But regardless, things are definitely not forgiving now, and or not well explained well enough on intuitive UIs/error messages, and I want to get as close as possible to perfection in those points as I can.
Things are in this state for a mixture of reasons, good and bad.
A big part is of course my blind spots due to lack of other users, which makes feedback like yours extremely valuable.
But there is also a pragmatic feeling that at least initially, we are more likely to get a small number of huge users than a large number of small users, because small users only come from Google to web edit, and Google won't ever see us unless some big users put amazing content.
In any case, I will try to get as close as perfection in in-app explanations as I can and any ideas toward that are welcome. I want users to be able to discover how to do things as much as possible without reading the docs, definitely.
Is there a way to not have a new line every time I put some latex in the text?
Do you mean like inline vs block maths with $ vs $$? As in:
My inline $\sqrt{2}$ is nice.

My block:

$$
\sqrt{2}
$$

is also nice.
which renders as:
My inline is nice.
My block:
(1)
is also nice.
Doc at: docs.ourbigbook.com/#mathematics That syntax is directly inspired from LaTeX btw.
Also: My new article's structure looks like this:
You can do code blocks with triple backticks like in markdown btw (though we are better and also support double backticks only :-)): docs.ourbigbook.com/#code-block
``
= Bleach
{scope}

== Whatever
``
which renders as:
= Bleach
{scope}

== Whatever
That should work. Could you show me all files in your local directory?
Notably, do you have the above in a file called "bleach.big"? Or is it just inside your README.bigb?
If separate file, you need to include as:
README.bigb
= Index

\Include[bleach]
If same file as in:
= Index

= Bleach

== Whatever
then it doesn't work for web upload, because everything has to be a child of = Index to go into web tree (all web goes under a single root). So instead you need:
= Index

== Bleach

=== Whatever
I should, and will add a error message for that case btw if its getting silently ignored. I had tried to be more general from before Web existed, and something need to be slightly restricted to work on web.
This is one of those "needs a better error message on my blindspot" cases.
#10 by pioyi (@pioyi, 6) on 2024-08-20
Thank you for your help! Basically everything would work if I had read the documentation correctly.
#11 by Ciro Santilli (@cirosantilli, 34) on 2024-08-20
Great news! If anything else comes up, ask away.
I checked now, the "multiple h1s" issue already has a "clear" message:
error: README.bigb:7:1: only one level 1 header is allowed in this conversion
(though at some point if people hit it often we can also add a link to a documentation section).
The missing Include possibility has a open ticket: github.com/ourbigbook/ourbigbook/issues/269
BTW, I'm curious at which level/which university/course you are at if you'd like to share that here or privately: ourbigbook.com/cirosantilli/contact This is totally optional of course. Philipino University undergrad is my guess (?) :-)
#12 by pioyi (@pioyi, 6) on 2024-08-20
hahahaha, Filipino? Is this a US term or are you referring to the ethnicity? My nickname kind of resembles something in tagalog if you mean that. I am a chemist (as you may have guessed) from Greece, still studying. I write about topics I am comfortable with.
#13 by Ciro Santilli (@cirosantilli, 34) on 2024-08-21
A person from the Philippines. I just Googled your username and it says it's a surname in the Philippines haha Feel free to write about anything you want, there are no penalties or interference of any kind.
#14 by Ciro Santilli (@cirosantilli, 34) on 2024-08-21
BTW I've added the following to docs.ourbigbook.com/ourbigbook-com-content-license I hope this is a reasonable clause given that I'm putting years of my life into this project. I understand it could put some people off, and I don't intend to ever relicense anything lightly, as it would be an instant reputational hit. This had been on the back of my mind for a while, but after seeing your contributions I've decided to do it now before more content gets added. It does not affect any of the pre-existing content.
Starting from August 22 2024, users also automatically grant to the OurBigBook Project a non-exclusive license to relicense their content. This could be used for example to:
  • sell the content to companies that do not wish to comply with the CC By-SA license, e.g. for LLM training. We will try to avoid ever doing this as much as possible since it goes against the vision of the project for open knowledge. But it could one day be the difference between life and death of the project, so we'd like to keep that door open just in case.
  • add a new license to content on the website which we feel might better serve all users
Any such relicensing does not affect the original CC BY-SA 4.0 license nor your ownership of the content. It only adds new licenses on top of it. This way the content remains free no matter what.
#15 by Ciro Santilli (@cirosantilli, 34) on 2024-08-23
I fixed the random logout issues at: github.com/ourbigbook/ourbigbook/commit/1175ae40cec5acc7297d4ffb450644966fcd01bb Let me know if you encounter any further problems with it.
Sign up or sign in to comment on this issue.